To set up Visual Studio for Enterprise Portal development

A standard lookup form is created through relations on the database table, and on the Extended Data Type. To learn about the standard lookup form, click .

If, however, you need to create a runtime lookup form that looks up other database fields than the ones offered by the standard lookup form, use the application class SysTableLookup and override the lookup method on the relevant form control.

How to use the SysTableLookup class

1. Create a new instance of SysTableLookup where 'this' is the current form control

   SysTableLookup    sysTableLookup = SysTableLookup::newParameters(tableNum(custTable), this);

2. Add the fields to be shown in the lookup form

    sysTableLookup.addLookupField(fieldNum(custTable, accountNum));

3. Limit the data selection.

    queryBuildDataSource = query.addDataSource(tableNum(custTable));

    queryBuildRange      = queryBuildDataSource.addRange(fieldNum(custTable, accountNum));

    queryBuildRange.value('A..B');

    sysTableLookup.parmQuery(query);

4. Perform the lookup, and delete super().
   super() will create an autogenerated lookup form.

    sysTableLookup.performFormLookup();

//    super()

}

A complete example of overriding the lookup method on a form control

void lookup()

{

    Query                   query          = new Query();

    QueryBuildDataSource    queryBuildDataSource;

    QueryBuildRange         queryBuildRange;

// Create an instance of SysTableLookup where 'this' the current Form control.

    SysTableLookup          sysTableLookup = SysTableLookup::newParameters(tableNum(custTable), this);

    ;

// The field to be shown in the lookup form.

    sysTableLookup.addLookupField(fieldNum(custTable, accountNum));

    sysTableLookup.addLookupField(fieldNum(custTable, name));

// Limit and arrange data selection.

    queryBuildDataSource = query.addDataSource(tableNum(custTable));

    queryBuildRange      = queryBuildDataSource.addRange(fieldNum(custTable, accountNum));

    queryBuildRange.value('A..B');

    sysTableLookup.parmQuery(query);

// Perform lookup

    sysTableLookup.performFormLookup();

// do not call super().

//    super()

}

void lookup()

{

  Query query = new Query();

  QueryBuildDataSource queryBuildDataSource;

  QueryBuildRange queryBuildRange;

  SysTableLookup sysTableLookup;

  TableId tableId;

  FieldId fieldId;

  ;

  tableId = tablename2id('myTable');

  sysTableLookup.parmTableId(tableId);

  fieldId = fieldname2id(tableId, 'MyField_1');

  sysTableLookup.addLookupfield(fieldId);

  fieldId = fieldname2id(tableId, 'MyField_2');

  sysTableLookup.addLookupfield(fieldId);

  queryBuildDataSource = query.addDataSource(tableId);

  queryBuildDataSource.orderMode(OrderMode::GROUPBY);

  queryBuildDataSource.addSortField(fieldId));

  sysTableLookup.parmQuery(query);

  this.performFormLookup(sysTableLookup.formRun());

}

This manner of creating a lookup form is used in the DocuType form in the application. The full path to the modified lookup method is:

\Forms\DocuType\Designs\Design\[Tab:Tab]\[TabPage:Overview]\[Grid:Grid]\StringEdit:ActionClassName\Methods.

Note

The SysTableLookup is limited to making lookups on fields in a table.

FROM AX DOCUMENT

ConIns

Syntax 

container ConIns (container container, 

             int start, 

             anytype element,... ) 

Exception message 

Inserts elements in the container specified by container. The elements are inserted at the position specified by start. If several elements are specified, they must be separated by commas. To insert an element as the first in a container, specify start as 1. To insert after the nth element specify start as n+1.

Example 

static void Job_Examples_conins_conlen_conpeek(Args _args)
{
  container c;
  int i;
  ;

  c = conins(["item1", "item2"], 1);  // conins to insert into container
  for (i = 1 ; i <= conlen(c) ; i++)  // conlen for the size of the container
  {
    print conpeek(c, i);              // conpeek to get contents of container item without removing it
  }

  pause;
}

Notes

You can also assign elements to a container:
container c = ["Hello World", 1, 3.14];

You can use the += operator to add values of any type into a container. For example, to create a container containing the first ten square numbers:
int i;
container c;
;

for (i = 1; i < = 10; i++)
{
    c += i+i;
}

See Also 

ConFind, ConDel, ConLen, ConNull, ConPeek, ConPoke

ConFind

Syntax 

int ConFind (container container, anytype element,... ) 

Exception message 

Locates the first occurrence of a specific sequence of elements in the container specified by container. If several elements are specified in the sequence, they must be separated by commas and given in the correct sequence. The elements can be of any data type.

Return Value 

The function returns 0 (the item was not found) or the item’s sequence number. 

Example 

static void Job_Examples_confind(Args _args)
{
  container c = ["item1", "item2", "item3"];
  int i;
  ;

 
  i = confind(c, "item2");
  print @"Position of 'item3' in container is " + int2str(i);
  pause;
}

See Also 

ConDel , ConIns , ConLen , ConNull , ConPeek , ConPoke

ConLen

Syntax

[HEADER]

Exception message  

Returns the number of elements in the container specified by container.

Example 

static void Job_Examples_conins_conlen_conpeek(Args _args)
{
  container c;
  int i;
  ;

  c = conins(["item1", "item2"], 1);  // conins to insert into container
  for (i = 1 ; i <= conlen(c) ; i++)  // conlen for the size of the container
  {
    print conpeek(c, i);              // conpeek to get contents of container item without removing it
  }

  pause;
}
 

See Also

ConFind, ConDel, ConIns, ConNull, ConPeek, ConPoke

ConNull

Syntax 

[HEADER]

Exception message 

Returns a null container. Use the function to explicitly dispose of the contents of a container.

Example 

static void Job_Examples_connull(Args _args)
{
  container c = ["item1", "item2", "item3"];
  ;

  print "Size of container is " + int2str(conlen(c));
  c = connull();  // set container to null
  print "Size of container after connull() is " + int2str(conlen(c));
  pause;
}

See Also 

ConFind, ConDel, ConIns, ConLen, ConPeek, ConPoke

ConPeek

Syntax 

[HEADER]

Exception message 

Returns a specific element from the container specified by container. The element is specified by number. Specify 1 to get the first element.

The conpeek function automatically converts the peeked item into the expected return type. Strings can automatically be converted into integers and reals, and vice versa.

Example

static void Job_Examples_conins_conlen_conpeek(Args _args)
{
  container c;
  int i;
  ;

  c = conins(["item1", "item2"], 1);  // conins to insert into container
  for (i = 1 ; i <= conlen(c) ; i++)  // conlen for the size of the container
  {
    print conpeek(c, i);              // conpeek to get contents of container item without removing it
  }

  pause;
}
 

Note 

You can extract more than one element from a container with a composite assignment:
void myMethod()
{
    str 10 s;
    int i;
    real r;
    container c = [1,3.14,"Hello"];
    ;

    // Extracts 1 into i, 3.14 into r and "Hello" into s
    [i,r,s] = c;
}

See Also 

ConFind, ConDel, ConIns, ConLen, ConNull, ConPoke

ConPoke

Syntax 

container ConPoke (container container, 

                  int start, 

                  anytype element,... ) 

Exception message 

Modifies the container specified by container by replacing one or more of the existing elements with the specified elements. The position of the first element to be replaced is specified by start. If several elements are specified, they must be separated by commas. To replace the first element, specify start as 1.

Example 

static void Job_Examples_conpoke(Args _args)
{
  container c1 = ["item1", "item2", "item3"];
  container c2;
  int i;
  void conPrint(container c)
  {
      for (i = 1 ; i <= conlen(c) ; i++)
      {
        print conpeek(c, i);
      }
  }
  ;
  conPrint(c1);
  c2 = conpoke(c1, 2, "PokedItem");
  print "";
  conPrint(c2);
  pause;
 }

ConFind , ConDel , ConIns , ConLen , ConNull , ConPeek

Use a progress indicator during operations that take more than 2 seconds.

• Use an hourglass mouse pointer if the process takes 2-7 seconds.
  
  
• Use a progress bar if the process takes 8 seconds or more.
  
  

Display an Hourglass Pointer

Display a Progress Bar

static void operationProgress(Args _args)
{
    #AviFiles
    SysOperationProgress progress = new SysOperationProgress();
    int i;

    ;

    progress.setCaption("My Task");
    progress.setAnimation(#AviUpdate);
    progress.setTotal(30000);
    for (i = 1; i <= 30000; i++)
    {
        progress.setText(strfmt("Step %1", i));
        progress.setCount(i, 1);
    }
}

Use More Than One Progress Indicator

static void SysOperationProgress(Args _args)
{
    #define.count1(10)
    #define.count2(5)
    #define.count3(200)
    #AviFiles
    
    // 3 bars.
    SysOperationProgress progress = new SysOperationProgress(3);
    int i, j, k;
    ;
 
    progress.setCaption("My Task");
    progress.setAnimation(#AviUpdate);
 
    // Bar 1.
    progress.setTotal(#count1, 1);
    // Bar 2.
    progress.setTotal(#count2, 2);
    // Bar 3.
    progress.setTotal(#count3, 3);
 
    for (i=0; i<#count1; i++)
    {
        // Bar 1.
        progress.setText(strfmt("Bar 1 - Step %1 of %2", i, #count1), 1);
        progress.setCount(i, 1);
        for (j=0; j<#count2; j++)
        {
            // Bar 2.
            progress.setText(strfmt("Bar 2 - Step %1 of %2", j, #count2), 2);
            progress.setCount(j, 2);
            for (k=0; k<#count3; k++)
            {
                // Bar 3.
                progress.setText(
                    strfmt("Bar 3 - Step %1 of %2", k, #count3), 3);
                progress.setCount(k, 3);
                sleep(20);      // Time-consuming task.
            }
        }
    }
}

User Input During an Operation

Using Progress Indicators with the Runbase Framework

{
    this.progressInit("Caption",10,#AviFileCopy,1,2);
    progress.setCount(bar1count);
    progress.setTotal(maxBar2Count,bar2count);
    ...
    ...
    progress.setCount(bar2count,2);
}

static void Send_toExcel(Args _args) {

   SysExcelApplication         ExcelApplication;
   SysExcelWorkBooks           ExcelWorkBooks;
   SysExcelWorkBook            ExcelWorkBook;
   SysExcelWorkSheets          ExcelWorkSheets;
   SysExcelWorkSheet           ExcelWorkSheet;
   SysExcelRange               ExcelRange;
   CustTable                   ct;
   int                         row;
   ;
   ExcelApplication = SysExcelApplication::construct();
   ExcelApplication.visible(true);

   ExcelWorkBooks = ExcelApplication.workbooks();
   ExcelWorkBook = ExcelWorkBooks.add();
   ExcelWorkSheets = ExcelWorkBook.worksheets();
   ExcelWorkSheet = ExcelWorkSheets.itemFromNum(1);

   while select * from ct
   {
       row++;
       ExcelWorkSheet.cells().item(row,1).value(ct.AccountNum);
       ExcelWorkSheet.cells().item(row,2).value(ct.Name);
   }

} --Gundhawk 02:30, 15 September 2007 (EDT)

=================================================================

static void CreateExcelDokument(Args _args)
{
   SysExcelApplication xlsApplication;
   SysExcelWorkBooks xlsWorkBookCollection;
   SysExcelWorkBook xlsWorkBook;
   SysExcelWorkSheets xlsWorkSheetCollection;
   SysExcelWorkSheet xlsWorkSheet;
   SysExcelRange xlsRange;
   CustTable custTable;
   int row = 1;
   str fileName;
   ;
   // Name des Exceldokuments.
   fileName = "C:\\test.xsl";

   // Excel initalisieren und öffnen.
   xlsApplication = SysExcelApplication::construct();
   xlsApplication.visible(true);

   // Neues Excel Worksheet erzeugen.
   xlsWorkBookCollection = xlsApplication.workbooks();
   xlsWorkBook = xlsWorkBookCollection.add();
   xlsWorkSheetCollection = xlsWorkBook.worksheets();
   xlsWorkSheet = xlsWorkSheetCollection.itemFromNum(1);

   // Zellenüberschriften in das Worksheet schreiben.
   xlsWorkSheet.cells().item(row,1).value('Account Num');
   xlsWorkSheet.cells().item(row,2).value('Name');

   row++;

   // Excel Worksheet mit Daten füllen (Excel-Zellen füllen).
   while select custTable
   {
      xlsWorkSheet.cells().item(row,1).value(custTable.AccountNum);
      xlsWorkSheet.cells().item(row,2).value(custTable.Name);
      row++;
   }

   // Prüfen ob das Dokument schon existiert.
   if(WinApi::fileExists(fileName))
   {
      WinApi::deleteFile(fileName);
   }

   // Excel Dokument speichern.
   xlsWorkbook.saveAs(fileName);

   // Excel schließen.
   xlsApplication.quit();
   xlsApplication.finalize();
}

Setting the AutoQuery property on a form data source to Yes causes the system to automatically generate the query that retrieves data to display in the form.

Modify the system-generated query to display a different set of data as the result of user input in the form.

1. Declare a variable of the type QueryBuildRange.
   
   
2. Initialize the QueryBuildRange variable.
   
   
3. Modify the form data source executeQuery method.
   
   

Declare a Variable of the Type QueryBuildRange

class FormRun extends ObjectRun
{
    QueryBuildRange   criteriaOpen;
    ...
}

Initialize the QueryBuildRange Variable

void init()
{
    super();
    criteriaOpen = this.Query().DataSourceNo(1).addRange(
        fieldNum(CustTrans,Open));
    ...
}

Modify the executeQuery Method

void executeQuery()
{
    switch (IncludeAll.Value())
    {
        case (1) :
            criteriaOpen.Value('1'); 
            break;
        case (0) :
            criteriaOpen.Value('0..1');
            break;
    }
    super();
}

Query range value expressions can be used in any query where you need to express a range that is more complex than is possible with the usual dot-dot notation (such as 5012 .. 5500).

For example, to create a query that selects the records from MyTable where field A equals x or field B equals y, do the following.

1. Add a range on field A.
   
   
2. Set the value of that range to the expression (if x = 10 or y = 20), as a string: ((A == 10) || (B == 20))
   
   

The rules for creating query range value expressions are:

• Enclose the whole expression in parentheses.
  
  
• Enclose all subexpressions in parentheses.
  
  
• Use the relational and logical operators available in X++.
  
  
• Only use field names from the range's data source.
  
  
• Use the dataSource.field notation for fields from other data sources in the query.
  
  

Values must be constants in the expression, so any function or outside variable must be calculated before the expression are evaluated by the query. This is typically done by using strFmt.

The example above will then look like the following code example.

strFmt('((A == %1) || (B == %2))',x,y)

To get complete compile-time stability you should use intrinsic functions to get the correct field names, as shown in the following code example.

strFmt('((%1 == %2) || (%3 == %4))',

    fieldStr(MyTable,A), x,

    fieldStr(MyTable,B), y)

Example using "inter table" relations