FormControl Class
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.
The FormControl class serves as the base class for all form controls.
public ref class FormControl : Microsoft::Dynamics::Ax::Xpp::XppObjectBase, Microsoft::Dynamics::AX::KernelInterop::IHasImplementationClass[Microsoft.Dynamics.Ax.Xpp.KernelClass]
public class FormControl : Microsoft.Dynamics.Ax.Xpp.XppObjectBase, Microsoft.Dynamics.AX.KernelInterop.IHasImplementationClass[<Microsoft.Dynamics.Ax.Xpp.KernelClass>]
type FormControl = class
inherit XppObjectBase
interface IHasImplementationClassPublic Class FormControl
Inherits XppObjectBase
Implements IHasImplementationClass- Inheritance
- Derived
- Attributes
- Implements
-
Microsoft.Dynamics.AX.KernelInterop.IHasImplementationClass
Remarks
You should not create an instance of this class. Use the specific control instead.
Constructors
| FormControl() | |
| FormControl(FormBuildControl, xFormRun) | |
| FormControl(IntPtr) |
Fields
| __k_FormControlId | |
| eventsInitialized | |
| kernelClass | (Inherited from XppObjectBase) |
Methods
| __shouldCallNew(Type) | |
| addXppProxyReference(Type, Object) | (Inherited from XppObjectBase) |
| alignControl() |
Determines whether the control should be aligned. |
| alignControl(Boolean) | |
| allowEdit() |
Determines whether the user can modify the contents of the control. |
| allowEdit(Boolean) | |
| allowSysSetup() |
Retrieves a value that indicates whether the control is shown in the SysSetup form. |
| applyBuild() | |
| autoDeclaration() |
Determines whether the system can declare a member variable that has the same name as the control. |
| autoDeclaration(Boolean) | |
| beginDrag(Int32, Int32) |
Is called when the user starts to drag a form control. |
| build() | |
| calcControlSize(Int32, Int32) |
Retrieves the size of the control. |
| Call(String, Object[], Type[], Object[]) | (Inherited from XppObjectBase) |
| canBeEditable() | |
| cancelTimeOut(Int32) | (Inherited from XppObjectBase) |
| changeTracker() | |
| configurationKey() |
Gets or sets the configuration key that is assigned to the control. |
| configurationKey(Int32) | |
| 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. |
| countryRegionCodes(String) | |
| createKernelClass(Object[], Type[], Object[]) | (Inherited from XppObjectBase) |
| currentRow() | |
| 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. |
| dataRelationPath(String) | |
| dataSourceObject() | |
| displayControl() |
Displays the control. |
| displayTarget() |
Gets or sets the value that indicates whether the control is displayed in the Finance and Operations client, in Enterprise Portal for Finance and Operations, or in both. |
| displayTarget(Int32) | |
| dragDrop() |
Determines whether drag-and-drop operations are enabled or disabled for the control. |
| dragDrop(Int32) | |
| dragLeave() |
Raises the dragLeave event to indicate that a mouse drag operation has left the current control. |
| dragOver(FormControl, FormDrag, Int32, Int32) |
Raises the dragOver event to indicate that a mouse drag operation is over the current control. |
| dragOverEx(Array, FormDrag, Int32, Int32) |
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(FormControl, FormDrag, Int32, Int32) |
Raises the drop event to indicate that a drop operation is being performed on the current control. |
| dropEx(Array, FormDrag, Int32, Int32) |
Raises the dropEx event to indicate that a drop operation is being performed on the current control. |
| editAutoPostback() | |
| editAutoPostback(Boolean) | |
| edtBinding() | |
| emptyCoCState(String) | |
| enabled() |
Determines whether the object is enabled or disabled. |
| enabled(Boolean) | |
| enableFormRef() | |
| enableFormRef(Boolean) | |
| endDrag() |
Is called when the user has finished dragging a form control. |
| EnsureEvents() | |
| equal(XppObjectBase) | (Inherited from XppObjectBase) |
| executeCancelableEvent(FormControlEventHandler, FormControlCancelEventArgs, Boolean) | |
| extendedStyle(String) | |
| fieldBinding() |
Retrieves the table and field bindings of the control into a FieldBinding derived class. |
| finalize() | (Inherited from XppObjectBase) |
| formatStr(Int32, Boolean, Int32, Boolean, Boolean) | |
| formDataSourceBindingObject() | |
| formRun() | |
| getBinding(String) | |
| getCoCState(String) | |
| getContextMenuOptions() | |
| getFormRootName() | |
| getFormRun() | |
| GetIntPtr() | (Inherited from XppObjectBase) |
| GetKernelInstanceUniqueId() | (Inherited from XppObjectBase) |
| getTimeOutTimerHandle() | (Inherited from XppObjectBase) |
| getXppProxyReference(Type) | (Inherited from XppObjectBase) |
| gotFocus() |
Indicates that the control has received focus. |
| handle() | |
| hasChanged() |
Sets or returns a value that indicates whether the contents of the control have changed. |
| hasChanged(Boolean) | |
| hasManagedOnJumpRefHandlers() | |
| hasManagedOnLookupHandlers() | |
| hasUserSetting() |
Indicates whether the control has custom user settings. |
| height(Int32, Int32) | |
| height(Int32) |
Gets or sets the height of the control. |
| heightMode() |
Gets or sets a calculation mode for the height of the control. |
| heightMode(Int32) | |
| heightValue() |
Gets or sets the height of the control. |
| heightValue(Int32) | |
| 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. |
| helpText(String) | |
| hierarchyParent() |
Gets or sets the HierarchyParent property value of the control. |
| hierarchyParent(String) | |
| hWnd() |
Retrieves the Windows handle for the control. |
| id() |
Retrieves the ID of the control. |
| initialize() | |
| InitializeEvents() | |
| inputSearch(String) |
Performs data filtering for the control, based on the specified string. |
| isDisplayed() |
Retrieves a value that indicates whether the control is displayed. |
| isEditable() | |
| isEnabled() | |
| IsManagedValid() | (Inherited from XppObjectBase) |
| isMandatory() | |
| isRestricted() |
Retrieves a value that indicates whether the control is restricted. |
| isUserSetupEnabled(Int32) |
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. |
| isVisibleOnClient() | |
| kernelhandle() | |
| KernelInstanceDisposed() | (Inherited from XppObjectBase) |
| labelId() | |
| labelText() |
Retrieves the label text for the control. |
| lastReferenceResolver() | |
| lastReferenceResolver(Object) | |
| left(Int32, Int32) | |
| left(Int32) |
Gets or sets the horizontal position of the control in the form. |
| leftMode() |
Sets the horizontal arrange mode for the control in the form. |
| leftMode(Int32) | |
| leftValue() |
Gets or sets the horizontal position of the control in the form. |
| leftValue(Int32) | |
| lock() |
Locks the form control. |
| lockWindowUpdate(Boolean) |
Locks or unlocks the window of the control for update. |
| lostFocus() |
Indicates that the control has lost focus. |
| MakeReflectionCall(String, Object[]) | (Inherited from XppObjectBase) |
| markAsUserAdd() |
Marks or unmarks the control as a user-added control. |
| markAsUserAdd(Boolean) | |
| mouseDblClick(Int32, Int32, Int32, Boolean, Boolean) |
Is called when the control is double-clicked by the user. |
| mouseDown(Int32, Int32, Int32, Boolean, Boolean) |
Is called when the user clicks the mouse button over the control. |
| mouseEnter(Int32, Int32, Int32, Boolean, Boolean) |
Is called when the user moves the mouse pointer into the control area. |
| mouseLeave() |
Indicates that the mouse pointer has left the control. |
| mouseMove(Int32, Int32, Int32, Boolean, Boolean) |
Is called when the user moves the mouse pointer over the control. |
| mouseUp(Int32, Int32, Int32, Boolean, Boolean) |
Is called when the user releases the mouse button over the control area. |
| moveControl(Int32, Int32) | |
| moveControl(Int32) | |
| name() |
Gets or sets the name that is used in code to identify a form, report, table, query, or other Finance and Operations application object. |
| name(String) | |
| neededPermission() | |
| neededPermission(Int32) | |
| nestedElementName() | |
| newmethod() | (Inherited from XppObjectBase) |
| newmethod(FormBuildControl, xFormRun) | |
| notify() | (Inherited from XppObjectBase) |
| notifyAll() | (Inherited from XppObjectBase) |
| objectOnServer() |
Obsolete.
(Inherited from XppObjectBase)
|
| onPropChanged(String) | |
| packUserSetting() | |
| parentControl() |
Retrieves the parent control for the control. |
| paste() |
Pastes the contents of the clipboard into the control. |
| prefColumnSize(Int32, Int32) |
Specifies the preferred column width and height for the form control. |
| reactBundleName() | |
| resetUserSetting() |
Resets the user settings for the control. |
| resourceBundleName() | |
| run() | |
| securityKey() |
Sets or returns the ID of the security key for the control. |
| securityKey(Int32) | |
| setFocus() |
Sets the focus on the control. |
| setNames(String, String) | |
| setReactBundleName(String) | |
| setResourceBundleName(String) | |
| setTemplateId(String) | |
| setTimeOut(String, Int32, Boolean) |
Obsolete.
(Inherited from XppObjectBase)
|
| setTimeOut(String, Int32) |
Obsolete.
(Inherited from XppObjectBase)
|
| showContextMenu(Int32) |
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. |
| skip(Boolean) | |
| templateId() | |
| toolTip() |
Retrieves the tooltip text for the control. |
| top(Int32, Int32) | |
| top(Int32) |
Gets or sets the vertical position of the control in the form. |
| topMode() |
Sets the vertical arrange mode for the control in the form. |
| topMode(Int32) | |
| topValue() |
Gets or sets the vertical position of the control in the form. |
| topValue(Int32) | |
| type() | |
| type(Int32) | |
| unLock(Boolean) |
Unlocks a form control. |
| unpackUserSetting(Object[]) | |
| update() |
Updates the control. |
| updateWindow() |
Updates the window for the control. |
| usageCount() | (Inherited from XppObjectBase) |
| userData() |
Gets or sets the user data for the control. |
| userData(Int32) | |
| userDataItem() |
Gets or sets the user data item for the control. |
| userDataItem(Int32) | |
| userDataItems() |
Gets or sets the number of user data items for the control. |
| userDataItems(Int32) | |
| userDisable() |
Gets or sets the value that indicates whether the control is disabled for the user. |
| userDisable(Int32) | |
| userHeight() |
Gets or sets the custom user height for the control. |
| userHeight(Int32) | |
| userHide() |
Gets or sets the value that indicates whether the control is hidden from the user. |
| userHide(Int32) | |
| userOrgContainer() |
Gets or sets the organization container for the control. |
| userOrgContainer(Int32) | |
| userOrgSibling() |
Gets or sets the organization sibling for the control. |
| userOrgSibling(Int32) | |
| userPromptText() |
Gets or sets the user label text for the control. |
| userPromptText(String) | |
| userSecurityLevel() |
Gets or sets the user security level for the control. |
| userSecurityLevel(Int32) | |
| 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. |
| userSkip(Int32) | |
| userWidth() |
Sets or returns the width of the control in pixels. |
| userWidth(Int32) | |
| valueStr() |
Retrieves the value of the control in string format. |
| VerifyKernelClass() | (Inherited from XppObjectBase) |
| verticalSpacing() |
Gets or sets the vertical spacing of the control in the form. |
| verticalSpacing(Int32, AutoMode) | |
| verticalSpacing(Int32) | |
| verticalSpacingMode() |
Sets the vertical spacing mode for the control in the form. |
| verticalSpacingMode(AutoMode) | |
| verticalSpacingValue() |
Gets or sets the vertical spacing of the control in the form. |
| verticalSpacingValue(Int32) | |
| visible() |
Sets or returns a value that indicates whether the control is visible. |
| visible(Boolean) | |
| wait() | (Inherited from XppObjectBase) |
| width(Int32, Int32) | |
| width(Int32) |
Gets or sets the width of the control. |
| widthMode() |
Gets or sets the calculation mode of the width of the control. |
| widthMode(Int32) | |
| widthValue() |
Gets or sets the width of the control. |
| widthValue(Int32) | |
| Xml() | (Inherited from XppObjectBase) |
| Xml(Int32) | (Inherited from XppObjectBase) |
Explicit Interface Implementations
| IHasImplementationClass._impl() |