Share via


FormAnimateControl.isUserSetupEnabled(Int32) Method

Definition

Returns a value that indicates whether the control allows for the specified level of customization.

public:
 override bool isUserSetupEnabled(int _neededSetupRights);
[Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnly]
public override bool isUserSetupEnabled (int _neededSetupRights);
[<Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnly>]
override this.isUserSetupEnabled : int -> bool
Public Overrides Function isUserSetupEnabled (_neededSetupRights As Integer) As Boolean

Parameters

_neededSetupRights
Int32

A value from the FormAllowUserSetup enumeration that specifies the level of customization that is being queried for the control. For more information, see "Remarks".

Returns

true if the control, design, and parent container allow for the level of customization that is specified by the neededSetupRights parameter; otherwise false.

Attributes
Microsoft.Dynamics.BusinessPlatform.SharedTypes.InternalUseOnlyAttribute

Remarks

The following table describes the values for the neededSetupRights parameters.

FormAllowUserSetup::No 0 No changes can be made to the control. Using this value for neededSetupRights always returns true.
FormAllowUserSetup::Restricted 1 The user can change the editable, visible, skip, label and width properties of the control. The user cannot move the control.
FormAllowUserSetup::Yes 2 The user can change the editable, visible, skip, label and width properties of the control. The user can also move the control.

This method returns true only if the AllowUserSetup property for the design and all parent containers is at least as high as the level that is specified by the neededSetupRights parameter.

Applies to