FormGroupControl 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.
public ref class FormGroupControl : Dynamics::AX::Application::FormControl[Microsoft.Dynamics.Ax.Xpp.KernelClass]
public class FormGroupControl : Dynamics.AX.Application.FormControl[<Microsoft.Dynamics.Ax.Xpp.KernelClass>]
type FormGroupControl = class
inherit FormControlPublic Class FormGroupControl
Inherits FormControl- Inheritance
- Attributes
Constructors
| FormGroupControl() | |
| FormGroupControl(FormBuildControl, xFormRun) | |
| FormGroupControl(IntPtr) |
Fields
| __k_FormGroupControlId | |
| eventsInitialized | (Inherited from FormControl) |
| kernelClass | (Inherited from XppObjectBase) |
Methods
| __shouldCallNew(Type) | (Inherited from FormControl) |
| addControl(FormControlType, String, FormControl) | |
| addControl(FormControlType, String) |
Adds a form control to a form group control. |
| addControlEx(String, String, FormControl) | |
| addControlEx(String, String) | |
| addDataField(Int32, Int32, FormControl, Int32) | |
| addDataField(Int32, Int32, FormControl) | |
| addDataField(Int32, Int32) |
Adds a table field. |
| addDataFieldWithName(Int32, Int32, String) | |
| addXppProxyReference(Type, Object) | (Inherited from XppObjectBase) |
| alignChild() |
Sets or returns a Boolean value that indicates whether a form group control is aligned in the same manner as other controls in a form. |
| alignChild(Boolean) | |
| alignChildren() |
Sets or returns a Boolean value that indicates whether the child controls are aligned. |
| alignChildren(Boolean) | |
| alignControl() |
Determines whether the control is aligned with other controls. |
| 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. |
| allowUserSetup() |
Sets or gets the level of modification that can be performed for a form group control. |
| allowUserSetup(Int32) | |
| applyBuild() | (Inherited from FormControl) |
| arrange() | |
| arrangeGuide() | |
| arrangeGuide(Int32) | |
| arrangeMethod() |
Sets or returns an integer value that indicates how controls in a form group control are arranged. |
| arrangeMethod(Int32) | |
| arrangeWhen() |
Sets or returns an integer value that specifies when the controls are arranged. |
| arrangeWhen(Int32) | |
| autoDataGroup() |
Sets or returns a Boolean value that specifies whether a form group control can contain only the fields in the data group that are specified for the control. |
| autoDataGroup(Boolean) | |
| autoDeclaration() |
Determines whether the system can declare a member variable that has the same name as the control. |
| autoDeclaration(Boolean) | |
| backgroundColor() |
Gets or sets the background color of the control. |
| backgroundColor(Int32) | |
| backgroundImage() |
Specifies the background image for a form group control. |
| backgroundImage(Image, Int32) | |
| backgroundImage(Image) | |
| backStyle() |
Determines whether the control background can be transparent. |
| backStyle(Int32) | |
| beginDrag(Int32, Int32) |
Is called when the user starts to move a form group control. |
| bold() |
Gets or sets the weight of font that is used to display text in the control. |
| bold(Int32) | |
| bottomMargin() |
Sets or returns the bottom margin of a form group control in pixels and specifies whether the margin is automatically adjusted. |
| bottomMargin(Int32, AutoMode) | |
| bottomMargin(Int32) | |
| bottomMarginMode() |
Sets or returns an AutoMode enumeration value that indicates whether the bottom margin is automatically adjusted. |
| bottomMarginMode(AutoMode) | |
| bottomMarginValue() |
Sets or returns the bottom margin of a form group control in pixels. |
| bottomMarginValue(Int32) | |
| breakable() | |
| breakable(Boolean) | |
| build() | (Inherited from FormControl) |
| calcControlSize(Int32, Int32) |
Calculates the size of a form group control, based on the number of characters and the number of lines. |
| Call(String, Object[], Type[], Object[]) | (Inherited from XppObjectBase) |
| canAddDataField(Int32, Int32, Int32) | |
| canAddDataField(Int32, Int32) |
Indicates whether a table field can be added. |
| canBeEditable() | (Inherited from FormControl) |
| cancelTimeOut(Int32) | (Inherited from XppObjectBase) |
| canContain(FormControl) |
Specifies whether a form group control can contain the specified form control. |
| caption() |
Gets or set the caption of the control. |
| caption(String) | |
| changeTracker() | (Inherited from FormControl) |
| characterSet() |
Gets or sets the character set of the font. |
| characterSet(Int32) | |
| clicked() |
Is called when a form group control is clicked by the user. |
| colorScheme() |
Gets or sets the color scheme of the control. |
| colorScheme(Int32) | |
| columns() |
Sets or returns the number of columns in a form group control in pixels, and specifies whether the number is automatically adjusted. |
| columns(Int32, ColumnsMode) | |
| columns(Int32) | |
| columnsMode() |
Sets or returns a value that indicates whether the number of columns in a form group control is fixed, or whether it is automatically adjusted based on other form settings, such as the form size. |
| columnsMode(ColumnsMode) | |
| columnspace() |
Sets or returns the amount of space between columns in a form group control in pixels and indicates whether the space is automatically adjusted based on other form settings, such the font size. |
| columnspace(Int32, AutoMode) | |
| columnspace(Int32) | |
| columnspaceMode() |
Sets or returns an AutoMode enumeration value that indicates whether the amount of space between columns in a form group control is automatically adjusted. |
| columnspaceMode(AutoMode) | |
| columnspaceValue() |
Sets or returns the amount of space between columns in a form group control in pixels. |
| columnspaceValue(Int32) | |
| columnsValue() |
Sets or returns the number of columns in a form group control. |
| columnsValue(Int32) | |
| 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 activated for a form group control. |
| containerId() |
Retrieves the ID of the parent container for the control. (Inherited from FormControl) |
| contains(FormControl) |
Specifies whether a form group control contains a specified form control. |
| context() |
Is called when the user right-clicks a form group control. |
| controlCount() |
Returns the number of controls in a form group control. |
| controlNum(Int32) |
Returns a FormControl object for a specified control in a form group control. |
| copy() |
Copies a form group control. |
| countryRegionCodes() |
Gets or sets the comma-separated list of country/region codes for the control. |
| countryRegionCodes(String) | |
| countryRegionContextField() | |
| countryRegionContextField(Int32) | |
| createKernelClass(Object[], Type[], Object[]) | (Inherited from XppObjectBase) |
| currentRow() | (Inherited from FormControl) |
| cut() |
Cuts the contents of the control. |
| dataGroup() |
Sets or returns a data group for a form group control. |
| dataGroup(String) | |
| 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) | |
| dataSource() |
Gets or sets a data source that will be used by the control or the form. |
| dataSource(Object) | |
| dataSourceObject() | (Inherited from FormControl) |
| displayControl() |
Displays a form group 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() |
Is called when the user drags an object out of the bounds of a form group control. |
| dragOver(FormControl, FormDrag, Int32, Int32) |
Is called when an object is dragged over the bounds of a form group 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) |
Is called when a user drops a form group control or an item in a form group control into a new position. |
| dropEx(Array, FormDrag, Int32, Int32) |
Raises the dropEx event to indicate that a drop operation is being performed on the current control. |
| editAutoPostback() | (Inherited from FormControl) |
| editAutoPostback(Boolean) | (Inherited from FormControl) |
| edtBinding() | (Inherited from FormControl) |
| emptyCoCState(String) | (Inherited from FormControl) |
| enableChilds() |
Specifies whether the child controls are enabled for a form group control. |
| enableChilds(Boolean) | |
| enabled() |
Determines whether the object is enabled or disabled. |
| enabled(Boolean) | |
| enableFormRef() | (Inherited from FormControl) |
| enableFormRef(Boolean) | (Inherited from FormControl) |
| endDrag() |
Is called when the user has finished moving a form group control. |
| EnsureEvents() | (Inherited from FormControl) |
| enter() |
Is called when the user moves focus to a form group control. |
| equal(XppObjectBase) | (Inherited from XppObjectBase) |
| executeCancelableEvent(FormControlEventHandler, FormControlCancelEventArgs, Boolean) | (Inherited from FormControl) |
| expand() |
Specifies whether a form group control is expanded. |
| expand(Boolean) | |
| extendedStyle(String) | (Inherited from FormControl) |
| fieldBinding() |
Retrieves the table and field bindings of the control into a FieldBinding derived class. (Inherited from FormControl) |
| filter() |
Is called when the user right-clicks a form group control and then clicks Filter By Selection. |
| filter(String) | |
| finalize() | (Inherited from XppObjectBase) |
| font() |
Gets or sets the name of the font that is used for text in a control. |
| font(String) | |
| fontSize() |
Gets or sets the font size to use for text in a control. |
| fontSize(Int32) | |
| formatStr(Int32, Boolean, Int32, Boolean, Boolean) | (Inherited from FormControl) |
| formDataSourceBindingObject() | (Inherited from FormControl) |
| formRun() | (Inherited from FormControl) |
| frameOptionButton() |
Sets or returns the option button for a form group control. |
| frameOptionButton(Int32) | |
| framePosition() |
Sets or returns the location of the frame for a form group control. |
| framePosition(Int32) | |
| frameType() |
Sets or returns the frame style for a form group control. |
| frameType(Int32) | |
| getBinding(String) | (Inherited from FormControl) |
| getCoCState(String) | (Inherited from FormControl) |
| getContextMenuOptions() | (Inherited from FormControl) |
| getFormRootName() | (Inherited from FormControl) |
| getFormRun() | (Inherited from FormControl) |
| GetIntPtr() | (Inherited from XppObjectBase) |
| GetKernelInstanceUniqueId() | (Inherited from XppObjectBase) |
| getTimeOutTimerHandle() | (Inherited from XppObjectBase) |
| getXppProxyReference(Type) | (Inherited from XppObjectBase) |
| gotFocus() |
Determines when the user brings a form group control into focus. |
| handle() | |
| hasChanged() |
Sets or returns a Boolean value that indicates whether the contents of a form group control have changed. |
| hasChanged(Boolean) | |
| hasManagedOnJumpRefHandlers() | |
| hasManagedOnLookupHandlers() | (Inherited from FormControl) |
| 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() |
Returns the Help text that is displayed in the status bar when a form group control is selected. |
| 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) | |
| hideIfEmpty() |
Sets or gets a Boolean value that indicates whether a form group control is visible when the controls in the group are not visible. |
| hideIfEmpty(Boolean) | |
| hierarchyParent() |
Gets or sets the HierarchyParent property value of the control. |
| hierarchyParent(String) | |
| hWnd() |
Returns a handle for a form group control. |
| id() |
Retrieves the ID of the control. (Inherited from FormControl) |
| initialize() | (Inherited from FormControl) |
| InitializeEvents() | |
| inputSearch(String) |
Is called when the user enters a search string in a bound control. |
| isContainer() |
Indicates whether a form group control is a container. |
| isDisplayed() |
Indicates whether a form group control is displayed. |
| isEditable() | (Inherited from FormControl) |
| isEnabled() | (Inherited from FormControl) |
| IsManagedValid() | (Inherited from XppObjectBase) |
| isMandatory() | (Inherited from FormControl) |
| isRestricted() |
Retrieves a value that indicates whether the control is restricted. |
| isUserSetupEnabled(Int32) |
Returns 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. (Inherited from FormControl) |
| isVisibleOnClient() | (Inherited from FormControl) |
| italic() |
Sets or returns a Boolean value that indicates whether the text for a form group control is italic. |
| italic(Boolean) | |
| jumpRef() |
Is called when a user clicks the Go to the Main Table Form command on a control shortcut menu in a form group control. |
| kernelhandle() | |
| KernelInstanceDisposed() | (Inherited from XppObjectBase) |
| labelBold() |
Sets or returns the font weight of the label text for a form group control. |
| labelBold(Int32) | |
| labelCharacterSet() |
Sets or returns the character set of the font for the label text for a form group control. |
| labelCharacterSet(Int32) | |
| labelFont() |
Sets or returns the font for the label text for a form group control. |
| labelFont(String) | |
| labelFontSize() |
Sets or returns the font size of the label text for a form group control. |
| labelFontSize(Int32) | |
| labelId() | (Inherited from FormControl) |
| labelItalic() |
Sets or returns a Boolean data type that indicates whether the label text for a form group control is italic. |
| labelItalic(Boolean) | |
| labelText() |
Retrieves the label text for the control. (Inherited from FormControl) |
| labelUnderline() |
Sets or returns a Boolean data type that indicates whether the label text for a form group control is underlined. |
| labelUnderline(Boolean) | |
| lastReferenceResolver() | (Inherited from FormControl) |
| lastReferenceResolver(Object) | (Inherited from FormControl) |
| leave() |
Is called when the user moves the mouse pointer out of a form group control. |
| left(Int32, Int32) | |
| left(Int32) |
Sets or returns the horizontal position of a form group control in pixels and specifies how the position is calculated. |
| leftMargin() |
Sets or returns the size of the left margin for a form group control in pixels and specifies whether the size is automatically adjusted. |
| leftMargin(Int32, AutoMode) | |
| leftMargin(Int32) | |
| leftMarginMode() |
Sets or returns a value that indicates whether the size of the left margin for a form group control is fixed, or whether it is automatically adjusted based on other form property settings. |
| leftMarginMode(AutoMode) | |
| leftMarginValue() |
Sets or returns the size of the left margin for a form group control in pixels. |
| leftMarginValue(Int32) | |
| leftMode() |
Sets or returns a value that indicates how the horizontal position of a form group control is calculated. |
| leftMode(Int32) | |
| leftValue() |
Sets or returns the horizontal position of a form group control in pixels. |
| leftValue(Int32) | |
| lock() |
Locks the form control. (Inherited from FormControl) |
| lockWindowUpdate(Boolean) |
Locks or unlocks the window of the control for update. (Inherited from FormControl) |
| lostFocus() |
Is called when the user brings a form group control out of 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 user double-clicks a form group control. |
| mouseDown(Int32, Int32, Int32, Boolean, Boolean) |
Is called when the user presses the mouse button in a form group control. |
| mouseEnter(Int32, Int32, Int32, Boolean, Boolean) |
Is called when the user moves the mouse pointer into the control area. |
| mouseLeave() |
Is called when the user moves the mouse pointer away from the control. |
| mouseMove(Int32, Int32, Int32, Boolean, Boolean) |
Is called when the user moves the mouse pointer over a form group control. |
| mouseUp(Int32, Int32, Int32, Boolean, Boolean) |
Is called when the user releases the mouse button over a form group control. |
| moveControl(Int32, Int32) | (Inherited from FormControl) |
| moveControl(Int32) | (Inherited from FormControl) |
| 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() | (Inherited from FormControl) |
| newmethod() | (Inherited from XppObjectBase) |
| newmethod(FormBuildControl, xFormRun) | (Inherited from FormControl) |
| notify() | (Inherited from XppObjectBase) |
| notifyAll() | (Inherited from XppObjectBase) |
| objectOnServer() |
Obsolete.
(Inherited from XppObjectBase)
|
| onPropChanged(String) | (Inherited from FormControl) |
| optionValue() |
Sets or returns the value for the option button that is associated with a form group control. |
| optionValue(Int32) | |
| packUserSetting() | |
| parentControl() |
Retrieves the parent control for the control. |
| paste() |
Pastes a form group control. |
| prefColumnSize(Int32, Int32) |
Specifies the height and width of columns for a form group control. |
| reactBundleName() | (Inherited from FormControl) |
| registerOverrideMethod(String, String, XppObjectBase) | |
| registerOverrideMethod(String, String) | |
| resetUserSetting() |
Resets the user settings for a form group control. |
| resourceBundleName() | (Inherited from FormControl) |
| rightMargin() |
Sets or returns the size of the right margin for a form group control in pixels and specifies whether the size is automatically adjusted. |
| rightMargin(Int32, AutoMode) | |
| rightMargin(Int32) | |
| rightMarginMode() |
Sets or returns a value that indicates whether the size of the right margin for a form group control is fixed, or whether it is automatically adjusted based on other form property settings. |
| rightMarginMode(AutoMode) | |
| rightMarginValue() |
Sets or returns the size of the right margin for a form group control in pixels. |
| rightMarginValue(Int32) | |
| run() | (Inherited from FormControl) |
| saveFilter() | |
| saveFilter(Boolean) | |
| securityKey() |
Sets or returns the security key ID for a form group control. |
| securityKey(Int32) | |
| setFocus() |
Sets the focus on the control. |
| setNames(String, String) | (Inherited from FormControl) |
| setReactBundleName(String) | (Inherited from FormControl) |
| setResourceBundleName(String) | (Inherited from FormControl) |
| setTemplateId(String) | (Inherited from FormControl) |
| setTimeOut(String, Int32, Boolean) |
Obsolete.
(Inherited from XppObjectBase)
|
| setTimeOut(String, Int32) |
Obsolete.
(Inherited from XppObjectBase)
|
| showContextMenu(Int32) |
Shows a shortcut menu for a form group control. |
| skip() |
Sets or returns a Boolean value that indicates whether the control is skipped when the user presses the TAB key to move to the control. |
| skip(Boolean) | |
| sort() |
Sorts the controls that are contained in a form group control. |
| sort(SortOrder) | |
| style() | |
| style(Int32) | |
| templateId() | (Inherited from FormControl) |
| toolTip() |
Returns the text string for the tooltip for a form group control. |
| top(Int32, Int32) | |
| top(Int32) |
Sets or returns the vertical position of a form group control in pixels and specifies how the position is calculated. |
| topMargin() |
Sets or returns the top margin for a form group control in pixels and specifies whether the size is automatically adjusted. |
| topMargin(Int32, AutoMode) | |
| topMargin(Int32) | |
| topMarginMode() |
Sets or returns a value that indicates whether the size of the top margin for a form group control is fixed, or whether it is automatically adjusted based on other form property settings. |
| topMarginMode(AutoMode) | |
| topMarginValue() | |
| topMarginValue(Int32) | |
| topMode() |
Sets or returns a value that indicates how the vertical position of a form group control is calculated. |
| topMode(Int32) | |
| topValue() |
Sets or returns the vertical position of a form group control in pixels. |
| topValue(Int32) | |
| type() | |
| type(Int32) | |
| underline() |
Sets or returns the underline property for the text in the control. |
| underline(Boolean) | |
| unLock(Boolean) |
Unlocks a form control. (Inherited from FormControl) |
| unpackUserSetting(Object[]) | |
| update() |
Updates the control. (Inherited from FormControl) |
| updateWindow() |
Updates the window for the control. (Inherited from FormControl) |
| 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() |
Sets or returns an integer data type that indicates whether a 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 an integer that indicates whether the form group control is skipped when the user presses the TAB key to move to controls. |
| userSkip(Int32) | |
| userWidth() |
Sets or returns an integer that indicates the width of a form group control in pixels. |
| userWidth(Int32) | |
| useUserLayout() |
Specifies whether to use the user-specified layout of a form group control. |
| useUserLayout(Boolean) | |
| valueStr() |
Retrieves the value of the control in string format. (Inherited from FormControl) |
| VerifyKernelClass() | (Inherited from XppObjectBase) |
| verticalSpacing() |
Gets or sets the amount of space above and below a form group control in pixels, and specifies how the space is calculated. |
| verticalSpacing(Int32, AutoMode) | |
| verticalSpacing(Int32) | |
| verticalSpacingMode() |
Sets or returns a value that indicates how the amount of space above and below a form group control is calculated. |
| verticalSpacingMode(AutoMode) | |
| verticalSpacingValue() |
Gets or sets the amount of space above and below a form group control in pixels. |
| verticalSpacingValue(Int32) | |
| viewEditMode() | |
| viewEditMode(Int32) | |
| visible() |
Gets or sets a Boolean data type that displays or hides a form group control. |
| 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 for 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) |
Events
| OnClicked | |
| OnEnter | |
| OnGotFocus | |
| OnJumpRef | |
| OnLeaving | |
| OnLostFocus |
Explicit Interface Implementations
| IHasImplementationClass._impl() | (Inherited from FormControl) |