AxLookup
Applies To: Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012
An AxLookup component displays a lookup in Enterprise Portal. It is used when creating lookups for non-bound fields. Bound fields (fields that are linked to an AxDataSource) can automatically display a lookup if one has been defined for the underlying field.
When you add an AxLookup component to the layout, use the context menu to specify the target control for the lookup. This is the field to which the selected value in the lookup will be returned.
Properties
The AxLookup component has the following properties:
Accessibility
Property |
Description |
|---|---|
AccessKey |
The keyboard shortcut used by the control. Not used for Enterprise Portal. |
TabIndex |
The tab order of the control. |
Appearance
Property |
Description |
|---|---|
BackColor |
This property is inherited from the base control. It is not specific to Enterprise Portal. |
BorderColor |
This property is inherited from the base control. It is not specific to Enterprise Portal. |
BorderStyle |
This property is inherited from the base control. It is not specific to Enterprise Portal. |
BorderWidth |
This property is inherited from the base control. It is not specific to Enterprise Portal. |
ButtonImageUrl |
Specifies the image to be displayed for the lookup button. The value will have the form ~/_layouts/ep/images/<image>. |
CssClass |
This property is inherited from the base control. It is not specific to Enterprise Portal. |
DisplayAnimationAfter |
Specifies the amount of time that must elapse (in milliseconds) before the progress circle is displayed in the lookup when it is expanded. Setting this property to a large value will prevent the progress circle from being displayed, because the data for the lookup will have already been loaded. |
Font |
This property is inherited from the base control. It is not specific to Enterprise Portal. |
ForeColor |
This property is inherited from the base control. It is not specific to Enterprise Portal. |
HoverCssClass |
Specifies the cascading style sheet class to use when the pointer is over the lookup control. |
InitialLookupHeight |
The height of the lookup when it is displayed. |
LookupWidth |
The width of the lookup when it is displayed. |
Behavior
Property |
Description |
|---|---|
AllowMarking |
Specifies whether multiple rows can be marked for the contents of the lookup. |
AllowPaging |
Specifies whether paging functionality is enabled for the lookup. |
AutoPostBack |
When set to true, the lookup will post back when the OK button is clicked. |
ButtonOnClientClick |
Specifies the client-side script that is run when the button is clicked. |
Enabled |
Specifies whether the lookup is enabled. |
EnableTheming |
Indicates whether the control can be themed. |
EnableViewState |
Specifies whether the control automatically saves its state for use in round-trips. |
HideSelectField |
When set to true, the field specified by the SelectField property will not be displayed in the lookup. The value for this field will still be returned by the lookup. This is useful when you do not want to show the value being returned by the lookup. |
HideSpecificSelectFields |
Not used for Enterprise Portal. |
LookupDataSetView |
Specifies the view from the data set to use for the lookup content. |
LookupType |
Specifies the source of the data for the lookup. The possible values are: DataSetField EDT CustomDataSet Custom |
PageSize |
The number of items in each page of the lookup contents. |
PredefinedButtons |
Specifies what buttons are displayed for the lookup. The possible values are: None Cancel Ok OkCancel |
RunLookupDataSetWhenOkClicked |
When set to true, the lookup will post back when the OK button is clicked. You may need to set this property to true to have custom lookups work properly. |
SelectField |
The field returned from the lookup when OK is clicked. |
Separator |
When multiple rows can be marked in the lookup, specifies the character that is placed between the field for each marked row that is returned from the lookup. |
ShowFilter |
Specifies whether the filter controls will be displayed in the lookup. |
SkinID |
The SkinId of the control skin that provides the skin of the control. |
Target |
The control to which the value from the lookup will be returned. |
ToolTip |
Not used for Enterprise Portal. |
Visible |
Indicates whether the control is visible and rendered. |
Data
Property |
Description |
|---|---|
Expressions |
The expressions that are bound to properties of the control. |
DataLookupField |
The field from the data set view that will be used for the lookup. Applies when the LookupType is set to DataSetField. |
DataSet |
The data set from which the data for the lookup will be retrieved. Applies when the LookupType is set to DataSetField. |
DataSetView |
The view from the data set from which data for the lookup will be retrieved. Applies when the LookupType is set to DataSetField. |
ExtendedDataType |
The extended data type that will be used for the lookup. Applies when the LookupType is set to EDT. |
ExtendedDataTypeArrayIndex |
The index of the array element to use from the extended data type. Applies when the LookupType is set to EDT. |
Layout
Property |
Description |
|---|---|
Height |
The height of the control. |
Width |
The width of the control. |
Lookup
Property |
Description |
|---|---|
LookupStyle |
Specifies when the items for the lookup will be loaded. Choosing OnDemand causes the lookup items to be loaded only when the user clicks on the lookup button. Choosing PreLoad causes the lookup items to be loaded at the time when the page loads. |
Misc
Property |
Description |
|---|---|
ID |
The programmatic name of the control. |
CacheScope |
Specifies the level at which the lookup content is cached. |
CausesValidation |
Specifies whether the controls in the validation group specified by the ValidationGroup property will be validated when the lookup is clicked. |
Fields |
Not used for Enterprise Portal. |
ValidationGroup |
The name of the validation group for which the validation controls will be validated when the lookup is clicked. Each validation control has a ValidationGroup property that specifies which validation group it is part of. |
Events
The AxLookup component has the events listed in the following table.
Event |
Description |
|---|---|
DataBinding |
Occurs when the server control binds to a data source. |
Disposed |
Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. |
Init |
Occurs when the server control is initialized, which is the first step in its lifecycle. |
Load |
Occurs when the server control is loaded into the System.Web.UI.Page object. |
Lookup |
Occurs when the lookup button is clicked. |
OkClicked |
Occurs when the OK button for the lookup is clicked. |
PreRender |
Occurs after the System.Web.UI.Control object is loaded but prior to rendering. |
Unload |
Occurs when the server control is unloaded from memory. |