FormBuildControl Class

Article
04/11/2014

The FormBuildControl class lets you create, read, update, and delete X++ code and metadata.

Syntax

class FormBuildControl extends Object

Run On

Called

Methods

	Method	Description
	addControl	Adds a control to the control, based on the specified control type.
	addDataField	Adds a control to the control, based on the specified data field information.
	canAddDataField	Retrieves a value that indicates whether the specified data field can be added as a child control to the control.
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	containerId	Retrieves the ID of the parent container for the control.
	controlCount	Retrieves the number of controls that are contained in the control.
	controlNum	Retrieves a contained control by using the specified index.
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	getTimeOutTimerHandle	Returns the timer handle for the object. (Inherited from Object.)
	handle	Retrieves the handle of the class of the object. (Inherited from Object.)
	hasUserSetting	Indicates whether the control has custom user settings.
	id	Retrieves the ID of the control.
	isContainer	Retrieves a value that indicates whether the control is a container control.
	markAsUserAdd	Marks or unmarks the control as a user-added control.
	moveControl	Moves a specified control to the control.
	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.
	resetUserSetting	Resets the user settings for the control.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	toString	Returns a string that represents the current object. (Inherited from Object.)
	unpackUserSetting	Unpacks the user settings 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.)
	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 press the TAB key to navigate the controls on the form.
	userWidth	Sets or returns the width of the control in pixels.
	wait	Pauses a process. (Inherited from Object.)
	xml	Returns an XML string that represents the current object. (Inherited from Object.)

Top

Remarks

Make sure that the user has access to the development security key (SysDevelopment) before this API is called.

Inheritance Hierarchy