FormRun Class

Syntax

class FormRun extends ObjectRun

Run On

Client

Methods

	Method	Description
	activate	Is called by the system when a form receives focus.
	addHistory
	allowPrimaryKeyPreview
	args	Returns the arguments that the object was constructed with. (Inherited from ObjectRun.)
	arrange	Arranges a form.
	attach	Reverses a call to the method. This is the reverse of calling the ObjectRun.detach method. Reversing the call disallows any further switching of focus between windows. (Inherited from ObjectRun.)
	blockPersonalization
	cancelTimeOut	Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
	canClose
	canSubmitToWorkflow
	close	Is called when a form is closed.
	closeCancel
	closed
	closedCancel
	closedOk
	closeOk
	closeSelect
	closeSelectRecord
	contains	Indicates whether a form contains a specified control.
	control	Retrieves a control on a form.
	controlCallingMethod
	controlId
	controlMethodOverload
	controlMethodOverloadObject
	copy
	createRecord
	currentHistoryName
	currentHistoryState
	cut	Is called when a user performs a cut operation on a form.
	dataSource	Retrieves a FormObjectSet object for a specified form data source.
	dataSourceCount	Retrieves the number of data sources that are associated with a form.
	defaultDataSource	Sets or returns a FormObjectSet object for a specified default form data source.
	defaultInitialQueryValuesOnCreate	Enables or disables the application of default values from the query build range and query filters from an InitialQueryParameter query when the FormDataSource::Create method is called.
	delAutoCompleteString
	design	Retrieves a FormDesign object.
	detach	Increases the number of references to a FormRun object. (Overrides the detach Method.)
	doApply
	docCursor
	enableCountryRegion
	equal	Determines whether the specified object is equal to the current one. (Inherited from Object.)
	finalize	Destructs the form object when the form is closed and then releases the allocated space of the object.
	firstField	Is called when a user opens a form or uses the CTRL+SHIFT+HOME keyboard shortcut.
	flushCountryRegionCodeCache
	form	Retrieves a Form object that the FormRun class executes.
	formOnTop
	getActiveWorkflowConfiguration
	getActiveWorkflowTrackingStatus
	getActiveWorkflowWorkItem
	getAutoCompleteString
	getFormHelpTopic	Retrieves the saved Help topic for the form.
	getNextField
	getPrevField	Retrieves a FormControl object for the field that precedes the field that is specified by a FormControl 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.)
	hasExecutedInit
	hWnd	Retrieves a Windows handle for the form.
	init
	initWorkflowControls
	installMessageProc
	inViewMode
	isDetached	Communicates whether an ObjectRun.detach method call has been made on this object. (Inherited from ObjectRun.)
	isPreloadedInstance	Indicates whether this instance was preloaded.
	isWorkflowEnabled
	lastField	Is called when a user navigates to the last field group in a form.
	loadUserSetting	Is called when the user settings for a form are loaded.
	loadWorkflowConfiguration
	lock	Prevents another user from updating a form.
	lockWindowUpdate
	modeledQueryName
	name	Retrieves the name of a form.
	new	Initializes a new instance of the Object class. (Overrides the new Method.)
	nextField
	nextGroup
	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.)
	objectSet	Retrieves a FormObjectSet object for a specified form data source.
	owner	Returns the instance that owns the object. (Inherited from Object.)
	pageInteraction
	paste
	prevField
	prevGroup
	print
	printPreview	Is called when a user clicks Print Preview on the File menu to view the automatic report for an active form.
	redraw
	reload
	removeMessageProc
	resetSize
	resetStatusBarBackgroundColor	Resets the background color of the status bar to its original color. Reverts the effect of all previous calls to the setStatusBarBackgroundColor method.
	resize	Is called when a form is resized.
	rootFormDataSources	Retrieves a List of the root FormDataSource instances for this instance of the FormRun class.
	run
	saveUserSetting	Is called when the user settings for a form are saved.
	selectControl
	selectedControl
	selectMode
	selectRecordMode
	selectRecordModeSelectedRecord
	selectTarget	Selects a control in a form.
	send	Prints an automatic report from the contents of a form.
	setActive	Sets a form as active and gives it focus.
	setApply
	setAutoCompleteString
	setFormHelpTopic	Sets the default Help topic that is used when the user presses F1 in the form.
	setOrder
	setParentHandle
	setStatusBarBackgroundColor	Sets the background color of the status bar to the specified color.
	setTimeOut	Sets up the scheduled execution of a specified method. (Inherited from Object.)
	skipSaveUserSetting
	sysColorChanged	Is called when the form color is changed.
	tabOrder	Specifies the order in which you navigate to form controls when you press the TAB key.
	task
	toString	Returns a string that represents the current object. (Overrides the toString Method.)
	unLock	Unlocks a form.
	updateHistory
	updateWorkflowControls
	usageCount	Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
	wait	Pauses a process. (Overrides the wait Method.)
	workflowDataSource
	workflowType
	xml	Returns an XML string that represents the current object. (Inherited from Object.)

Top

Inheritance Hierarchy

Object Class
  ObjectRun Class
    FormRun Class
      SysFormRun Class
      SysSetupFormRun Class