FormControl Class

The FormControl class serves as the base class for all form controls.

Syntax

class FormControl extends Object

Run On

Client

Methods

	Method	Description
	alignControl	Determines whether the control should be aligned.
	allowEdit	Determines whether the user can modify the contents of the control.
	allowSysSetup	Retrieves a value that indicates whether the control is shown in the SysSetup form.
	autoDeclaration	Determines whether the system can declare a member variable that has the same name as the control.
	beginDrag	Is called when the user starts to drag a form control.
	calcControlSize	Retrieves the size of the control.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	configurationKey	Gets or sets the configuration key that is assigned to the control.
	configurationKeyEx	Retrieves a list that contains the IDs of configuration keys that are in effect for the control.
	containerId	Retrieves the ID of the parent container for the control.
	context	Shows the shortcut menu for the control.
	copy	Copies the contents of the control to the clipboard.
	countryRegionCodes	Gets or sets the comma-separated list of country/region codes for the control.
	cut	Cuts the contents of the control.
	dataRelationPath	Gets or sets the period-delimited list of relations that links the field binding of the DataField object to a relative table.
	dataSourceObject
	displayControl	Displays the control.
	displayTarget	Gets or sets the value that indicates whether the control is displayed in the Microsoft Dynamics AX client, in Enterprise Portal for Microsoft Dynamics AX, or in both.
	dragDrop	Determines whether drag-and-drop operations are enabled or disabled for the control.
	dragLeave	Raises the dragLeave event to indicate that a mouse drag operation has left the current control.
	dragOver	Raises the dragOver event to indicate that a mouse drag operation is over the current control.
	dragOverEx	Raises the dragOverEx event to indicate that a mouse drag operation is over the current control.
	dragText	Retrieves the text that is displayed when the form control is dragged.
	drop	Raises the drop event to indicate that a drop operation is being performed on the current control.
	dropEx	Raises the dropEx event to indicate that a drop operation is being performed on the current control.
	enabled	Determines whether the object is enabled or disabled.
	endDrag	Is called when the user has finished dragging a form control.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	fieldBinding	Retrieves the table and field bindings of the control into a FieldBinding derived class.
	formRun
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	gotFocus	Indicates that the control has received focus.
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	hasChanged	Sets or returns a value that indicates whether the contents of the control have changed.
	hasUserSetting	Indicates whether the control has custom user settings.
	height	Gets or sets the height of the control.
	heightMode	Gets or sets a calculation mode for the height of the control.
	heightValue	Gets or sets the height of the control.
	helpField	Retrieves the Help text for the control.
	helpText	Gets or sets the Help text that is displayed at the bottom of the screen when a field or control is pointed to.
	hierarchyParent	Gets or sets the HierarchyParent property value of the control.
	hWnd	Retrieves the Windows handle for the control.
	id	Retrieves the ID of the control.
	inputSearch	Performs data filtering for the control, based on the specified string.
	isDisplayed	Retrieves a value that indicates whether the control is displayed.
	isRestricted	Retrieves a value that indicates whether the control is restricted.
	isUserSetupEnabled	Retrieves a value that indicates whether the control allows for the specified level of customization.
	isVisible	Retrieves a value that indicates whether the control is visible.
	labelText	Retrieves the label text for the control.
	left	Gets or sets the horizontal position of the control in the form.
	leftMode	Sets the horizontal arrange mode for the control in the form.
	leftValue	Gets or sets the horizontal position of the control in the form.
	lock	Locks the form control.
	lockWindowUpdate	Locks or unlocks the window of the control for update.
	lostFocus	Indicates that the control has lost focus.
	markAsUserAdd	Marks or unmarks the control as a user-added control.
	mouseDblClick	Is called when the control is double-clicked by the user.
	mouseDown	Is called when the user clicks the mouse button over the control.
	mouseEnter	Is called when the user moves the mouse pointer into the control area.
	mouseLeave	Indicates that the mouse pointer has left the control.
	mouseMove	Is called when the user moves the mouse pointer over the control.
	mouseUp	Is called when the user releases the mouse button over the control area.
	name	Gets or sets the name that is used in code to identify a form, report, table, query, or other Microsoft Dynamics AX application object.
	neededPermission
	new	Initializes a new instance of the Object class. (Inherited from Object.)
	notify	Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
	notifyAll	Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
	objectOnServer	Determines whether the object is on a server. (Inherited from Object.)
	owner	Returns the instance that owns the object. (Inherited from Object.)
	packUserSetting	Packs the user settings for the control.
	parentControl	Retrieves the parent control for the control.
	paste	Pastes the contents of the clipboard into the control.
	prefColumnSize	Specifies the preferred column width and height for the form control.
	resetUserSetting	Resets the user settings for the control.
	securityKey	Sets or returns the ID of the security key for the control.
	setFocus	Sets the focus on the control.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	showContextMenu	Shows the shortcut menu for the control.
	skip	Sets or returns a value that indicates whether the control is skipped when the user presses the TAB key to move to the control.
	toolTip	Retrieves the tooltip text for the control.
	top	Gets or sets the vertical position of the control in the form.
	topMode	Sets the vertical arrange mode for the control in the form.
	topValue	Gets or sets the vertical position of the control in the form.
	toString	Returns a string that represents the current object. (Inherited from Object.)
	type
	unLock	Unlocks a form control.
	unpackUserSetting	Unpacks the user settings for the control.
	update	Updates the control.
	updateWindow	Updates the window for the control.
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	userData	Gets or sets the user data for the control.
	userDataItem	Gets or sets the user data item for the control.
	userDataItems	Gets or sets the number of user data items for the control.
	userDisable	Gets or sets the value that indicates whether the control is disabled for the user.
	userHeight	Gets or sets the custom user height for the control.
	userHide	Gets or sets the value that indicates whether the control is hidden from the user.
	userOrgContainer	Gets or sets the organization container for the control.
	userOrgSibling	Gets or sets the organization sibling for the control.
	userPromptText	Gets or sets the user label text for the control.
	userSecurityLevel	Gets or sets the user security level for the control.
	userSkip	Sets or returns the value that indicates whether the form control is skipped when the user presses the TAB key to navigate the controls in the form.
	userWidth	Sets or returns the width of the control in pixels.
	valueStr	Retrieves the value of the control in string format.
	verticalSpacing	Gets or sets the vertical spacing of the control in the form.
	verticalSpacingMode	Sets the vertical spacing mode for the control in the form.
	verticalSpacingValue	Gets or sets the vertical spacing of the control in the form.
	visible	Sets or returns a value that indicates whether the control is visible.
	wait	Pauses a process. (Inherited from Object.)
	width	Gets or sets the width of the control.
	widthMode	Gets or sets the calculation mode of the width of the control.
	widthValue	Gets or sets the width of the control.
	xml	Returns an XML string that represents the current object. (Inherited from Object.)

Top

Remarks

You should not create an instance of this class. Use the specific control instead.

Inheritance Hierarchy

Object Class
  FormControl Class
    FormActionPaneControl Class
    FormActionPaneTabControl Class
    FormActiveXControl Class
    FormAnimateControl Class
    FormButtonControl Class
    FormButtonGroupControl Class
    FormButtonSeparatorControl Class
    FormCheckBoxControl Class
    FormComboBoxControl Class
    FormCommandButtonControl Class
    FormDateControl Class
    FormDateTimeControl Class
    FormDropDialogButtonControl Class
    FormFastTabHeaderControl Class
    FormFastTabSummarySeparator Class
    FormFilterPaneControl Class
    FormFunctionButtonControl Class
    FormGridControl Class
    FormGroupControl Class
    FormGuidControl Class
    FormHTMLControl Class
    FormInt64Control Class
    FormIntControl Class
    FormListBoxControl Class
    FormListControl Class
    FormManagedHostControl Class
    FormMenuButtonControl Class
    FormProgressControl Class
    FormRadioControl Class
    FormRealControl Class
    FormReferenceControl Class
    FormRichTextControl Class
    FormStaticTextControl Class
    FormStringControl Class
    FormTabControl Class
    FormTableControl Class
    FormTabPageControl Class
    FormTimeControl Class
    FormTreeControl Class
    FormWindowControl Class