FormTreeControl Class

Definition

public ref class FormTreeControl : Dynamics::AX::Application::FormControl
[Microsoft.Dynamics.Ax.Xpp.KernelClass]
public class FormTreeControl : Dynamics.AX.Application.FormControl
[<Microsoft.Dynamics.Ax.Xpp.KernelClass>]
type FormTreeControl = class
    inherit FormControl
Public Class FormTreeControl
Inherits FormControl
Inheritance
Microsoft.Dynamics.AX.KernelInterop.ProxyBase
FormTreeControl
Attributes

Constructors

FormTreeControl()
FormTreeControl(FormBuildControl, xFormRun)
FormTreeControl(IntPtr)

Fields

__k_FormTreeControlId
eventsInitialized (Inherited from FormControl)
kernelClass (Inherited from XppObjectBase)

Methods

__shouldCallNew(Type) (Inherited from FormControl)
add(Int32, Int32, String)
add(Int32, Int32, String, Int32)
add(Int32, Int32, String, Int32, Int32)
addItem(Int32, Int32, FormTreeItem)
addXppProxyReference(Type, Object) (Inherited from XppObjectBase)
alignControl()

Determines whether to align the control.

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() (Inherited from FormControl)
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)
backStyle()

Determines whether the control background can be transparent.

backStyle(Int32)
beginDrag(Int32, Int32)

Is called when the user starts to drag a form tree control.

beginEditLabel(Int32)
beginLabelEdit(Int32, String, Object)
bold()

Gets or sets the font weight that is used to display text in the control.

bold(Int32)
border()

Gets or sets the style of the border for the control.

border(Int32)
build() (Inherited from FormControl)
calcControlSize(Int32, Int32)

Retrieves the size of the control.

Call(String, Object[], Type[], Object[]) (Inherited from XppObjectBase)
canBeEditable() (Inherited from FormControl)
cancelTimeOut(Int32) (Inherited from XppObjectBase)
canScroll()
canScroll(Boolean)
cascadeSelect()
cascadeSelect(Boolean)
changeTracker() (Inherited from FormControl)
characterSet()

Gets or sets the character set of the font.

characterSet(Int32)
checkBox()
checkBox(Boolean)
checkedStateChanged(Int32, FormTreeCheckedState)
colorScheme()

Gets or sets the color scheme of the control.

colorScheme(Int32)
configurationKey()

Gets or sets the configuration key that is assigned to the control.

configurationKey(Int32)
configurationKeyEx()

Returns 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.

(Inherited from FormControl)
context()

Shows the shortcut menu for the control.

copy()

Copies the form tree control.

copyItem(Int32, Int32)
copyItem(Int32, Int32, Int32)
countryRegionCodes()

Gets or sets the comma-separated list of country/region codes for the control.

countryRegionCodes(String)
createDragImagelist()
createKernelClass(Object[], Type[], Object[]) (Inherited from XppObjectBase)
currentRow() (Inherited from FormControl)
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() (Inherited from FormControl)
delete(Int32)

Deletes the specified item from the form tree control.

deleteAll()

Deletes all items from the form tree control.

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()

Returns the text that is displayed when the form tree 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() (Inherited from FormControl)
editAutoPostback(Boolean) (Inherited from FormControl)
editLabels()
editLabels(Boolean)
edtBinding() (Inherited from FormControl)
emptyCoCState(String) (Inherited from FormControl)
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 dragging a form tree control.

endEditLabel(Boolean)
endLabelEdit(Int32, String, Object)
EnsureEvents() (Inherited from FormControl)
enter()
equal(XppObjectBase) (Inherited from XppObjectBase)
executeCancelableEvent(FormControlEventHandler, FormControlCancelEventArgs, Boolean) (Inherited from FormControl)
expand(Int32)
expand(Int32, FormTreeExpand)
expanded(Int32, FormTreeExpand, Object)
expanding(Int32, FormTreeExpand, Object)
extendedStyle(String) (Inherited from FormControl)
fieldBinding()

Retrieves the table and field bindings of the control into a FieldBinding derived class.

(Inherited from FormControl)
finalize() (Inherited from XppObjectBase)
font()

Gets or sets the name of the font that is used for the text in the control.

font(String)
fontSize()

Gets or sets the font size that is used for the text in the control.

fontSize(Int32)
foregroundColor()

Gets or sets the color that is used for the text in the control.

foregroundColor(Int32)
formatStr(Int32, Boolean, Int32, Boolean, Boolean) (Inherited from FormControl)
formDataSourceBindingObject() (Inherited from FormControl)
formRun() (Inherited from FormControl)
getBinding(String) (Inherited from FormControl)
getChild(Int32)
getCoCState(String) (Inherited from FormControl)
getContextMenuOptions() (Inherited from FormControl)
getFirstSelected()
getFirstVisible()
getFormRootName() (Inherited from FormControl)
getFormRun() (Inherited from FormControl)
getImagelist()
GetIntPtr() (Inherited from XppObjectBase)
getItem(Int32)
GetKernelInstanceUniqueId() (Inherited from XppObjectBase)
getNextSelected(Int32)
getNextSibling(Int32)
getNextVisible(Int32)
getParent(Int32)
getPrevSelected(Int32)
getPrevSibling(Int32)
getPrevVisible(Int32)
getRoot()
getSelectedCount()
getSelection()
getStateImagelist()
getTimeOutTimerHandle() (Inherited from XppObjectBase)
getVisibleCount()

Returns the number of visible items in the tree control.

getXppProxyReference(Type) (Inherited from XppObjectBase)
gotFocus()

Indicates that the control has received focus.

handle()
hasButtons()

Returns a value that indicates whether the tree control uses expand/collapse buttons.

hasButtons(Boolean)
hasChanged()

Sets or returns a value that indicates whether the contents of the tree control have changed.

hasChanged(Boolean)
hasLines()

Returns a value that indicates whether the tree control displays tree connector lines.

hasLines(Boolean)
hasManagedOnJumpRefHandlers() (Inherited from FormControl)
hasManagedOnLookupHandlers() (Inherited from FormControl)
hasUserSetting()

Indicates whether the control has custom user settings.

height(Int32)

Gets or sets the height of the control.

height(Int32, Int32)
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 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)
hitTest(Int32, Int32)
hWnd()

Returns the Windows handle for the control.

id()

Retrieves the ID of the control.

(Inherited from FormControl)
initialize() (Inherited from FormControl)
InitializeEvents()
inputSearch(String)

Performs data filtering for the control, based on the specified string.

isContainer()

Returns a value that indicates whether the control is a container.

isDisplayed()

Returns a value that indicates whether the 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)

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.

(Inherited from FormControl)
isVisibleOnClient() (Inherited from FormControl)
italic()

Sets or returns a value that indicates whether the text in the control is italic.

italic(Boolean)
itemCopy(Int32, Int32)
itemDeleted(Int32, Object)
itemMoved(Int32, Int32)
kernelhandle()
KernelInstanceDisposed() (Inherited from XppObjectBase)
keyDown(Int32, Boolean, Boolean)
labelId() (Inherited from FormControl)
labelText()

Retrieves the label text for the control.

(Inherited from FormControl)
lastReferenceResolver() (Inherited from FormControl)
lastReferenceResolver(Object) (Inherited from FormControl)
leave()
left(Int32)

Gets or sets the horizontal position of the control in the form.

left(Int32, Int32)
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)
linesAtRoot()
linesAtRoot(Boolean)
lock()

Locks the form control.

(Inherited from FormControl)
lockWindowUpdate(Boolean)

Locks or unlocks the window of the control for update.

(Inherited from FormControl)
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 while the mouse pointer is over the control.

mouseEnter(Int32, Int32, Int32, Boolean, Boolean)

Is called when the user moves the mouse pointer into the control.

mouseLeave()

Is called when the user moves the mouse pointer out of 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 while the mouse pointer is over the control.

moveControl(Int32) (Inherited from FormControl)
moveControl(Int32, Int32) (Inherited from FormControl)
moveItem(Int32, Int32)
moveItem(Int32, Int32, Int32)
name()

Gets or sets the name that is used in code to identify a form, report, table, query, or another 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)
packUserSetting()
parentControl()

Retrieves the parent control for the control.

paste()

Pastes the form tree control in the form.

prefColumnSize(Int32, Int32)

Specifies the preferred column width and height for the form tree control.

reactBundleName() (Inherited from FormControl)
registerOverrideMethod(String, String)
registerOverrideMethod(String, String, XppObjectBase)
resetUserSetting()

Resets the user settings for the control.

resourceBundleName() (Inherited from FormControl)
rowSelect()
rowSelect(Boolean)
run() (Inherited from FormControl)
securityKey()

Sets or returns the ID of the security key for the control.

securityKey(Int32)
select(Int32)
selectEx(Int32, Boolean)
selectionChanged(FormTreeItem, FormTreeItem, FormTreeSelect)

Indicates that the user has changed the selected item in the form tree control.

selectionChanging(FormTreeItem, FormTreeItem, FormTreeSelect)
selectItems(Int32, Int32)
selectSetFirstVisible(Int32)
setFocus()

Sets the focus on the control.

setImagelist(Imagelist)
setInsertMark(Int32, Boolean)
setItem(FormTreeItem)
setNames(String, String) (Inherited from FormControl)
setReactBundleName(String) (Inherited from FormControl)
setResourceBundleName(String) (Inherited from FormControl)
setStateImagelist(Imagelist)
setTemplateId(String) (Inherited from FormControl)
setTimeOut(String, Int32)
Obsolete.
(Inherited from XppObjectBase)
setTimeOut(String, Int32, Boolean)
Obsolete.
(Inherited from XppObjectBase)
showContextMenu(Int32)

Shows the shortcut menu for the control.

showSelAlways()
showSelAlways(Boolean)
singleSelection()
singleSelection(Boolean)
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() (Inherited from FormControl)
toolTip()

Returns the tooltip text for the control.

top(Int32)

Gets or sets the vertical position of the control in the form.

top(Int32, Int32)
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)
trackSelect()
trackSelect(Boolean)
type()
type(Int32)
underline()
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()

Returns or sets the value that indicates whether the form tree 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()

Sets or retrieves the user prompt 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, as specified by the user.

userWidth(Int32)
valueStr()

Retrieves the value of the control in string format.

(Inherited from FormControl)
VerifyKernelClass() (Inherited from XppObjectBase)
verticalSpacing()

Gets or sets the vertical spacing of the control in the form.

verticalSpacing(Int32)
verticalSpacing(Int32, AutoMode)
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)

Gets or sets the width of the control.

width(Int32, Int32)
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

OnEnter
OnExpanded
OnExpanding
OnGotFocus
OnLeaving
OnLostFocus
OnSelectionChanged

Explicit Interface Implementations

IHasImplementationClass._impl() (Inherited from FormControl)

Applies to