Effector 6.3 developer manual

XML reference 6.3

Effector Studio 6.3 summary

Effector Studio 6.3 manual

Effector 6.2 developer manual

XML reference 6.0

Effector Studio 3.2 summary

Effector Studio 3.2 manual

DisplayDefinition

The xml files starting with dgvc were originally stored in the Display directory. Now they are located in the DisplayDefinition directory and the prefix of the files has been modified from dgvc to DisplayDefinition. Such an xml can appear on the interface as a Table, TransposedTable, Card, CardMatrix, TreeView, SectionList or Calendar control.

/DisplayDefinition

Root element.

/DisplayDefinition/Caption (String)

It is the caption of the DisplayDefinition, which currently does not show up on the interface. Its use is necessary for the Effector Studio.

/DisplayDefinition/DataDefinition (String)

The source of data. It is the name of the DataDefinition file (without extension) with which we would like to display queried data on the interface.

/DisplayDefinition/IsDynamic (Boolean)

If we want to display data from a dynamic source, we have to set the value of this node to true. It is an optional logical value that defaults to false.

/DisplayDefinition/UniqueIDColumn (String)

A column in the 'DisplayDefintion` in which the system looks for the ID value after making a new record.

/DisplayDefinition/UniqueBusinessObject (String)

This setting of the DisplayDefinition is used to mark out new rows. It is the name of the BusinessObject that needs to be identical with the one on the … doing the new registration .

/DisplayDefinition/OrderBy (String)

It is the SQL name of the column, based on which we want to arrange the rows of the table by default. Using the direction attribute, we can set the direction of arrangement, its possible values are Asc and Desc, the default value is Asc.

/DisplayDefinition/OutFilterColumn (String)

It is the name of the column in the DataDefinition that plays a primary role in handling the filter.

/DisplayDefinition/PageSize (Integer)

Here we can set how many rows are displayed on a page. Its value is an integer, it defaults to: 100. If its value is -1, the system practically turns off the paging function.

/DisplayDefinition/AlternatePageSize (Integer)

With this, we can regulate what happens when clicking on the element displaying the row numbers on the interface. Its value is an integer number, it defaults to 0.

  • If its value is -1, the table will load all rows upon clicking.
  • If its value is 0, these is no alternate page size (that is, nothing happens).
  • If it is a positive integer, the page size will change to this new value upon clicking.

/DisplayDefinition/TemplateURL (String)

/DisplayDefinition/AutoRefreshInterval (Integer)

The automatic refresh function is regulated with the value set in the AutoRefreshInterval node. Its value is understood in minutes. In the absence of the node or when its value is set to zero, the automatic refresh function is disabled.

/DisplayDefinition/IsToolbarVisible (Boolean)

It is an optional logical setting, that regulates the visibility of the toolbar. It defaults to true.

/DisplayDefinition/RowIdentificationMethod (Enumeration)

It regulates the method of row selection. Its value may be: UniqueIDColumnOrOutFilterColumn, GeneratedGUID. It defaults to UniqueIDColumnOrOutFilterColumn.

  • UniqueIDColumnOrOutFilterColumn: It uses the values of columns defined in the UniqueIDColumn or OutFilterColumn settings to identify a row. If both settings exist, the UniqueIDColumn setting prevails.
  • GeneratedGUID: The system generates a unique ID for each row. It is useful when we cannot specify a column identifying the selected row explicitly.

/DisplayDefinition/ViewType (Enumeration)

Here we can select the component responsible for displaying the data source set in the DataDefinition. Its possible values are: Table, Card, CardMatrix, Calendar, SectionList, Tree, TransposedTable, it defaults to Table.

  • Table: Tabular view.
  • TransposedTable: Transposed tabular view.
  • Card: Card list view.
  • CardMatrix: It facilitates displaying cards in a matrix-like arrangement.
  • Calendar: Calendar view.
  • SectionList: Section list view.
  • Tree: Tree view.

The settings pertaining to the individual views can be specified under separate nodes.

/DisplayDefinition/AlternateViewType (Enumeration)

Here we can set an alternative view. Currently it can assume the following values: None, Table, Card, CardMatrix, its default value is None.

/DisplayDefinition/ToolbarOptions

It joins the settings relevant to the toolbar.

/DisplayDefinition/ToolbarOptions/IsSelectionTypeTogglerVisible (Boolean)

A button appears on the toolbar allowing switching between multi-row and single-row selection.

/DisplayDefinition/ToolbarOptions/IsCardGroupLayoutChangeEnabled (Boolean)

In case of a Card view, a button regulating the group layout function appears on the toolbar (allowing switching between horizonal and vertical group layout).

/DisplayDefinition/ToolbarOptions/IsOpenAllColumnsButtonVisible (Boolean)

In case of a Table view, this setting regulates whether the button used for opening all the columns is visible on the toolbar. (It expands all collapsed columns in the table.)

/DisplayDefinition/ToolbarOptions/IsRowNumberTogglerVisible (Boolean)

In case of a Table view, this setting regulates the visibility of the row number toggle.

/DisplayDefinition/ToolbarOptions/IsToolsTogglerVisible (Boolean)

In case of a Table view, it regulates the visibility of the toggle used to display or hide the tool column on the toolbar.

/DisplayDefinition/ToolbarOptions/TrashCanActionControl (String)

It defines the DeleteObjectButton type of button on the ControlPanel whose pressing is simulated by the trash can icon on the toolbar.

/DisplayDefinition/ToolbarOptions/DefaultSelectionType (Enumeration)

We can set the default row selection method (card). Its values are: Single, Multiple. The default value is Single.

/DisplayDefinition/TableViewOptions

It joins the settings pertaining to the Table views.

/DisplayDefinition/TableViewOptions/IsRowNumberVisible (Boolean)

It defines whether the column displaying the row numbers is visible by default. It defaults to false.

/DisplayDefinition/TableViewOptions/Summaries

It joins the settings relevant to the values to be displayed in the summary rows.

/DisplayDefinition/TableViewOptions/Summaries/Summary (String)

Attributes:

  • column: the column to be aggregated
  • type: the type of aggregation. Its value may be:
    • Sum: adding up the values of the column
    • Average: calculating the average of the values in the column
    • Count: counting the number of values in the column
    • Maximum: the maximum of the values in the column
    • Minimum: the minimum of the values in the column
    • Custom: displaying arbitrary text below the column set in the Column attribute. The text should be specified as the value of the node.

Example:

<Summaries>
    <Summary type="Custom" column="CustomerName">Összesen:</Summary>
    <Summary type="Sum" column="Salary"></Summary>
    <Summary type="Average" column="DailyWork"></Summary>
</Summaries>

/DisplayDefinition/TableViewOptions/IsDeleteToolVisible (Boolean)

It regulates whether the delete function button is visible in the column containing the tools. The name of the push-button responsible for delete function has to be specified using the actionControl attribute. (It is the DeleteObjectButton defined on the CotrolPanel.)

/DisplayDefinition/TableViewOptions/IsCardPreviewToolVisible (Boolean)

This setting regulates the visibility of the Card display button in the column containing the tools. (It is visible only if the Card ViewType or AlternateViewType is defined.)

/DisplayDefinition/TableViewOptions/IsEditToolVisible (Boolean)

This setting regulates the visibility of the pencil icon in the column containing the tools. The pencil icon basically simulates a click on the Link bringing up the first Form . The automatic selection can be overridden in the columnName attribute. This setting should contain the name of the column the Link references.

/DisplayDefinition/TableViewOptions/IsSimpleFilterEnabled (Boolean)

This setting is used to hide or show the simple filters in the header of the grid. Its default value is true, that is, the function is switched on.

/DisplayDefinition/TableViewOptions/IsPinningEnabled (Boolean)

It regulates the visibility of the drop-down menu allowing column pinning. Its default value is true.

/DisplayDefinition/TableViewOptions/ColumnGroups

This node joins the settings used for the definition of column groups. Using the excludedColumnsGroupCaption attribute, we can specify the text to be displayed above the ungrouped columns.

/DisplayDefinition/TableViewOptions/ColumnGroups/ColumnGroup

It joins the settings used for the definition of the column group. With the name attribute, we need to define the group`s name to which we can refer when defining the columns.

/DisplayDefinition/TableViewOptions/ColumnGroups/ColumnGroup/Caption (String)

It is the caption of the column group.

Example:

<ColumnGroups excludedColumnsGroupCaption="">
    <ColumnGroup name="cimeleje">
        <Caption />
    </ColumnGroup>
    <ColumnGroup name="cim">
        <Caption>Cím</Caption>
    </ColumnGroup>
</ColumnGroups>

/DisplayDefinition/TableViewOptions/GroupBy (String)

Using this setting, we can specify based on which column the table be group by default. With the Direction attribute we can set the direction of grouping, its value may be Asc or Desc.

/DisplayDefinition/TableViewOptions/HeaderHeight (Integer)

It defines the height of the header in pixels. For a two-row header the value should be 48.

/DisplayDefinition/TableViewOptions/ColumnCaptions

In case of dynamic grids, the column header is, by default, the value returned by the query defined in the DataDefinition node. Replacing these headers with the result of a different query or a fixed value is an option. The source can be defined in the sourceType attribute. The value of this attribute may be Database or XML. The default value is Database.

/DisplayDefinition/TableViewOptions/ColumnCaptions/Database

If the value of the sourceType attribute under the ColumnCaptions node is Database, the system obtains the column captions from the result of the query defined here.

/DisplayDefinition/TableViewOptions/ColumnCaptions/Database/SelectionString (String)

In this setting, we can define the SQL query, which will return the data. The query should return Name and Caption columns. The type attribute specifies whether the setting will be an SQL statement or a stored procedure. Its value may be Select or StoredProcedure, where Select is the default value.

/DisplayDefinition/TableViewOptions/ColumnCaptions/FixedValues

If the value of the sourceType attribute under the ColumnCaptions node is XML, the system obtains the column captions from here.

/DisplayDefinition/TableViewOptions/ColumnCaptions/FixedValues/Caption (String)

The columnName attribute specifies the column whose caption is being defined, where the value of the node is the caption itself.

/DisplayDefinition/TableViewOptions/IsMultilineRowsEnabled (Boolean)

A setting used only in case of Table views to turn on the feature that allows variable row height depending on content. The maxLineNumber attribute defines the maximum number of rows the system can break a text into, while the minLineNumber attribute specifies the default number of rows in a cell. The row height calculation can be set in IsMultiline when columns are defined, the system draws on the values of these columns when calculating row heights.

/DisplayDefinition/TransposedTableViewOptions

It clusters the settings pertaining to the TransposedTable.

/DisplayDefinition/TransposedTableViewOptions/ColumnCaptions

In case of dynamic grids, the column header is, by default, the value returned by the query defined in the DataDefinition node. Replacing these headers with the result of a different query or a fixed value is an option. The source can be defined in the sourceType attribute. The value of this attribute may be Database or XML. The default value is Database.

/DisplayDefinition/TransposedTableViewOptions/ColumnCaptions/Database

If the value of the sourceType attribute under the ColumnCaptions node is Database, the system obtains the column captions from the result of the query defined here.

/DisplayDefinition/TransposedTableViewOptions/ColumnCaptions/Database/SelectionString (String)

In this setting, we can define the SQL query, which will return the data. The query should return Name and Caption columns. The type attribute specifies whether the setting will be an SQL statement or a stored procedure. Its value may be Select or StoredProcedure, where Select is the default value.

/DisplayDefinition/TransposedTableViewOptions/ColumnCaptions/FixedValues

If the value of the sourceType attribute under the ColumnCaptions node is XML, the system obtains the column captions from here.

/DisplayDefinition/TransposedTableViewOptions/ColumnCaptions/FixedValues/Caption (String)

The columnName attribute specifies the column whose caption is being defined, where the value of the node is the caption itself.

/DisplayDefinition/HTMLTemplates/

This node joins the html template definitions.

/DisplayDefinition/HTMLTemplates/HTMLTemplate (String)

This setting is used in case of Calendar, Card, CardMatrix, SectionList and Tree views. Using this setting, we can define the appearance and content of a card. Its content can be a string containing HTML expressions or a URL. The URL must reference an HTML file containing HTML elements. Effector replaces the [##Name##] type expressions with the values received from the database (in the above example, the values of the Name column are replaced).

  • width: With this attribute, we can set the width of the card (in pixel).
  • height: With this attribute, we can set the height of the card (in pixel).
  • isTemplateURL: With this attribute, we can set whether the value of the setting is a URL (True) or not (False`). (Example 2)
  • when: Alternate cards can be defined using this and the is setting. Its value is the name of a column whose value specifies which card template is used. In case of the default card template, the When attribute is not defined. (Example 3)
  • is: Alternate cards can be defined using this and the when setting. The value of the column set in the when attribute must be set here, which determines whether the given template is needed or not. (Example 3)

Example 1:

<HTMLTemplates>
    <HTMLTemplate><![CDATA[
        <div class="listview_item_content_01" style="background:url(core/gfx/images/card_organization_bg.png);overflow:hidden;height:100%">
        <div style="height:17px;font-size: 13px;top:2px;left: 55px;position:absolute;width: 237px;white-space:nowrap;overflow:hidden;text-overflow:ellipsis;color:#fff;">[##Name##]</div>
            <div class="CmpBtn" style="position:absolute;top:0px;right:0px;font-size:25px;color:#fff;">[##EditLink##]</div>
            <div style="left: 55px;font-size:12px;width: 240px;height:35px;position:absolute;top: 51px;color:#555555;text-overflow:ellipsis;overflow:hidden;" title="[##Zip##] [##City##], [##Street##] [##StreetNumber##]."><span style="color:#D57D62;">Address:</span> [##Zip##] [##City##], [##Street##] [##StreetNumber##].</div>
        </div>
    ]]></HTMLTemplate>
</HTMLTemplates>

Example 2:

<HTMLTemplates>
    <HTMLTemplate isTemplateURL="true">delivery/html/card.html</HTMLTemplate>
</HTMLTemplates>

Example 3:

<HTMLTemplates>
    <HTMLTemplate isTemplateURL="true" when="priority_level" is="high">delivery/html/high_prio_project.html</HTMLTemplate>
    <HTMLTemplate isTemplateURL="true" when="priority_level" is="low">delivery/html/low_prio_project.html</HTMLTemplate>
    <HTMLTemplate isTemplateURL="true">delivery/html/project.html</HTMLTemplate>
</HTMLTemplates>

/DisplayDefinition/CardViewOptions

This node clusters the settings pertaining to Card views.

/DisplayDefinition/CardViewOptions/IsAnimationEnabled (Boolean)

This setting is used for turning the animation on or off. It defaults to true.

/DisplayDefinition/CardViewOptions/DragAndDropControlName (String)

This setting is used with Card and CardMatrix views. Using drag&drop, it is possible to drag a card onto another card, after which a ProcessResultSet call linked to an invisible button (a Control on the ControlPanel) is made. Here we have to set the Name value of that button.

/DisplayDefinition/CardViewOptions/CardClickControlName (String)

This setting is used with Card and CardMatrix views. When clicking on (selecting) a card, we have the option to make a ProcessResultSet call. Here we have to set the Name value of the button (a Control on the ControlPanel) that makes the ProcessResultSet call.

/DisplayDefinition/CardViewOptions/IsGroupingEnabled (Boolean)

Using this setting, the grouping function can be turned on/off. It defaults to true.

/DisplayDefinition/CardViewOptions/IsSortingEnabled (Boolean)

Using this setting, the sorting criterion can be defined. The default value is true.

/DisplayDefinition/CardViewOptions/GraphByColumns (String)

It contains the names of the columns - separated by commas - to which the iGraph display mode is applicable. Effector adjusts the length of the individual cards according to the column selected on the interface, in which case the cards are displayed under one another. Effector displays the values relevant to the individual cards on their right-hand side.

/DisplayDefinition/CardViewOptions/GroupCssClassList (String)

It is an optional setting of Card views. Groups can feature diverse styles. These alternate styles can be set here. Its value is a list of CSS class names separated by commas. Currently it can assume the following values: alter1, alter2, alter3, alter4, alter5, alter6, alter7, alter8. Any number of these can be used. If there are more groups than the names of CSS classes set here, it will go on with the first one. Optional attribute.

/DisplayDefinition/CardViewOptions/CssFloat (String)

A setting is used with Card views, with which the float setting of the cards defined in the CSS can be overridden.

/DisplayDefinition/CardViewOptions/GroupLayout (Enumeration)

A setting is used with Card views, with which the grouping orientation can be set. It is an optional setting; its value can be Horizontal or Vertical. Its default value is Vertical.

/DisplayDefinition/CardViewOptions/ShowGroupElementCount (Boolean)

A setting is used with Card views, in case of grouping it defines whether the number of cards in the group be visible next to the title of the group. Its default value is true.

/DisplayDefinition/CardViewOptions/GroupBy (String)

With this setting, we can specify the default grouping in case of Card views. With the Direction attribute, the direction of grouping can be set, its value may be Asc or Desc.

/DisplayDefinition/CardMatrixViewOptions

Is joins the settings relevant to the CardMatrix view.

/DisplayDefinition/CardMatrixViewOptions/IsAnimationEnabled (Boolean)

It is a setting pertaining to CardMatrix views. The cards displayed on the interface are animated. In certain cases, it is worth turning this function off. Its default value is True.

/DisplayDefinition/CardMatrixViewOptions/DragAndDropControlName (String)

This setting is used with Card and CardMatrix views. Using drag&drop, it is possible to drag a card onto another card, after which a ProcessResultSet call linked to an invisible button (a Control on the ControlPanel) is made. Here we have to set the Name value of that button.

/DisplayDefinition/CardMatrixViewOptions/CardClickControlName (String)

This setting is used with Card and CardMatrix views. When clicking on (selecting) a card, we have the option to make a ProcessResultSet call. Here we have to set the Name value of the button (a Control on the ControlPanel) that makes the ProcessResultSet call.

/DisplayDefinition/CardMatrixViewOptions/ColumnCount (Integer)

This setting is used with CardMatrix views. The value set here indicates the number of cards displayed in a row after which they system opens a new row.

/DisplayDefinition/CardMatrixViewOptions/WidthColumn (String)

This setting is used with CardMatrix views. It specifies the name of the column which defines the width of the given card in pixels, making it possible to feature cards with various sizes.

/DisplayDefinition/CardMatrixViewOptions/HeightColumn (String)

This setting is pertaining to CardMatrix views. It contains the name of the column which defines the height of the given card in pixels, making it possible to feature cards with various sizes.

/DisplayDefinition/TreeViewOptions

This node clusters the settings relevant to Tree views.

/DisplayDefinition/TreeViewOptions/ParentIDColumn (String)

It is the ID of the DataDefinition column containing the ID of the parent of the given node.

/DisplayDefinition/TreeViewOptions/IDColumn (String)

It is the ID of the column defined in the DataDefinition that clearly identifies a node.

/DisplayDefinition/CalendarViewOptions

It joins the settings pertaining to Calendar views.

/DisplayDefinition/CalendarViewOptions/StartDateColumn (String)

It is the ID of the DataDefinition column which contains the start date of the item to be displayed in the calendar.

/DisplayDefinition/CalendarViewOptions/EndDateColumn (String)

It is the ID of the DataDefinition column which contains the end date of the item to be displayed in the calendar.

/DisplayDefinition/CalendarViewOptions/NewObjectButtonName (String)

It is the name of the button on the ControlPanel that is responsible for recoding new items.

/DisplayDefinition/CalendarViewOptions/DateRangeControlName (String)

It is the name of the button on the ControlPanel that filters the data displayed in the calendar for date range (in the calendar, the interval pacer controls the value of this filter).

/DisplayDefinition/CalendarViewOptions/StartHour (Integer)

Only events starting from this hour of the day are shown in the calendar. Its default value is 0.

/DisplayDefinition/CalendarViewOptions/EndHour (Integer)

Only events starting before this hour of the day are shown in the calendar. Its default value is 24.

/DisplayDefinition/Columns

This node clusters the definitions of the grid columns.

/DisplayDefinition/Columns/Column

It is a column of the grid. The column defined in the DataDefinition should be referenced using the name attribute.

/DisplayDefinition/Columns/Column/DisallowGrouping (Boolean)

With this setting we can regulate the accessibility of the grouping function on the column. Its default value is false, that is, the grouping option is allowed.

  • Every visible column (non-dynamic) (Visibility rule) can be included in a grouping.
  • If a columnsVisiblevalue istrueand itsDisallowGroupingvalue is alsotrue`, the column values cannot be grouped.
  • If a columnsVisiblevalue isfalseand itsDisallowGroupingvalue is alsofalse`, the column values can still be grouped.

/DisplayDefinition/Columns/Column/DisallowSorting (Boolean)

This setting controls the availability of the sorting function of the column. Its default value is false, that is, the sorting option is allowed.

  • Every visible column (non-dynamic) (Visibility rule) can be included in a sorting.
  • If a columnsVisiblevalue istrueand itsDisallowSortingvalue is alsotrue`, the column cannot be sorted.

  • If a columnsVisiblevalue isfalseand itsDisallowSortingvalue is alsofalse`, the column can still be sorted.

/DisplayDefinition/Columns/Column/IsPinned (Boolean)

In a Table view, the given row is pinned to the left. It defaults to false.

/DisplayDefinition/Columns/Column/IsMultiline (Boolean)

It defines whether Effector should use the value of this column to calculate the height of the row. Its default value is false.

/DisplayDefinition/Columns/Column/Format (Enumeration)

Using this setting, we can define the formatting of the data to be displayed in the cell. Its possible values are:

  • Auto: The system automatically formats the content. It is the default setting.
  • ThousandGrouped: The data in the cell is to be displayed using thousand grouping. In the Precision attribute, the number of digits displayed in the fractional part of the figure can be set (the default value is 0).
  • Date: The system displays only the date part of the time value shown in the cell.
  • DateTime: The system displays the time value in the cell including date, hours and minutes.
  • DateTimeWithSeconds: The system displays the time value in the cell including date, hour, minutes and seconds.

/DisplayDefinition/Columns/Column/Caption (String)

It is the caption displayed in the header of the column. It is an optional setting, in its absence, the column reference set in the name attribute will appear on the interface.

/DisplayDefinition/Columns/Column/HeaderCssClass (String)

It is the name of the CSS class describing the format of the column header. It is an optional setting. The CSS classes have to be defined in the delivery/gfx/style.css file.

/DisplayDefinition/Columns/Column/CellCssClassColumn (String)

Column cells can be formatted. In this setting we have to set the name of the column included in a DataDefinition XML that contains the name of the CSS class to be applied on the cell. The CSS classes have to be defined in the delivery/gfx/style.css file.

/DisplayDefinition/Columns/Column/InplaceEditControl

This node joins the setting pertaining to inplace editing. The system considers this setting only if a Readonly rule is defined for the column.

/DisplayDefinition/Columns/Column/InplaceEditControl/Type (Enumeration)

It defines the input field type used for inplace editing in the column. Its value may be:

  • TextBox: simple text input field
  • ComboBox: drop-down list input field
  • QueryTextBox: input field using pop-up window for value selection

/DisplayDefinition/Columns/Column/InplaceEditControl/Required (RuleValueType)

It determines whether the input field used for inplace editing is mandatory.

/DisplayDefinition/Columns/Column/InplaceEditControl/KeyColumn (String)

This setting is applicable only in case of a ComboBox type input filed used for inplace editing. We can set the name of the column containing the values of the drop-down list (ID), since the edit field is used typically in a column that actually displays the ID value, that is, the edit field in displayed in the owner column, but the ownerID field (this should be set using the KeyColumn setting) will be edited.

/DisplayDefinition/Columns/Column/InplaceEditControl/ComboDefinition (String)

This setting is applicable only in case of a ComboBox type input filed used for inplace editing. It is the name of the ComboDefinition XML describing the items of the Drop-down list without the extension.

/DisplayDefinition/Columns/Column/InplaceEditControl/LookupFilterName (String)

This setting is applicable only in case of a ComboBox type input filed used for inplace editing. It is optional. If the value set of the referenced drop-down list can be further narrowed by setting a filter, the name of such a filter can be specified in this setting.

/DisplayDefinition/Columns/Column/InplaceEditControl/LookupFilterValue (String)

This setting is applicable only in case of a ComboBox type input filed used for inplace editing. It is optional. If the value set of the referenced drop-down list can be further narrowed by setting a filter, the value of such a filter can be specified in this setting.

/DisplayDefinition/Columns/Column/InplaceEditControl/ComputedValueList (RuleValueType)

This setting is applicable only in case of a ComboBox type input filed used for inplace editing. It is optional. If the items of the drop-down list should be dynamically computed, it can be done by setting this rule.

/DisplayDefinition/Columns/Column/InplaceEditControl/Mask (String)

This setting is applicable only in case of an input filed of TextBox type used for inplace editing. With its help, we can specify a mask, for example <Mask>99999999-9-99</Mask>. For further information please refer to the Form documentation.

/DisplayDefinition/Columns/Column/InplaceEditControl/IsMultiline (Boolean)

This setting is applicable only in case of a TextBox type input filed used for inplace editing. It allows a multi-line input field. Its default value is false.

/DisplayDefinition/Columns/Column/InplaceEditControl/Height (Integer)

This setting is applicable only in case of a multi-line TextBox type input filed used for inplace editing. Here we can set the height of the input field in pixels.

/DisplayDefinition/Columns/Column/InplaceEditControl/FieldProperties

In case of inplace editing, here we can set the properties of the field in the database.

Attributes:

  • type: The type of the given field. Its possible values are System.String, System.Int16, System.Int32, System.Int64, System.Byte, System.Double. Its default value is System.String.
  • allowDBNull: It regulates if the value null allowed. It is applicable in case of System.String only.
  • maxLength: The maximum length of the field; it is applicable in case of System.String only. (0 is the default value, that is, even though the editor appears, no entry can be made.)
  • isEncrypted: Encryption is turned on in the field.

/DisplayDefinition/Columns/Column/Visible (RuleValueType)

It is the rule defining the visibility of the column, its default value is true, that is, the column is visible.

/DisplayDefinition/Columns/Column/Readonly (RuleValueType)

This rule specifies whether the cells in the column is editable or not. The rules default value isfalse`, that is, the cells cannot be edited.

/DisplayDefinition/Columns/Column/Width (Integer)

It specifies the width of the column; its value is a positive integer to be understood in pixels.

/DisplayDefinition/Columns/Column/ColumnGroupName (String)

It is the name of the column group, to which the given column will belong.

/DisplayDefinition/ControlPanel

It joins the settings pertaining to the panel containing the filters.

/DisplayDefinition/ControlPanel/LayoutType (Enumeration)

It regulates the location of the filter field and its caption relative to one another. Its value can be Horizontal or Vertical. The default value is Vertical.

/DisplayDefinition/ControlPanel/UseIcons (Boolean)

It regulates the visibility of an icon next to the caption. It defaults to false.

/DisplayDefinition/ControlPanel/ManualSearchTriggering (Boolean)

This setting regulates whether filtering is initiated by the change of the filter value or a push-button is displayed, which has to be clicked to start filtering. Its default value is false, which means that filtering is triggered by value change.

/DisplayDefinition/ControlPanel/Controls

This node clusters the filter fields and push-buttons defined on the ControlPanel.

/DisplayDefinition/ControlPanel/Controls/Control

This joins the settings pertaining to the filter fields and push-buttons displayed on the ControlPanel.

/DisplayDefinition/ControlPanel/Controls/Control/Type (Enumeration)

The type of the filter field or push-button featured on the ControlPanel has to be specified here. Its values can be:

  • ComboSearch: It filters the dataset using a value selected from a ComboBox control.
  • BoolSearch: Using the three-state checkbox control, we can filter bool-type columns.
  • DateSearch: Using the date-time picker control, a dataset can be filtered by a given date.
  • DateRange: This control is used for date range filtering.
  • TextSearch: A single-line text editing control for free text (or number) search.
  • ActionButton: It represents a push-button, which can assume various functions. For example: calling a function of an external module, generating documents, excel export, etc.
  • QuerySearch: It is similar to a ComboBox, with the difference that here a selection window pops up (where values are selected from a grid).
  • TagCloud: It is used for tag cloud filtering.
  • NewObjectButton: It is a push-button used to add a new object. In such a case, Effector opens the screen specified in the Screen setting (and the form displayed on that screen generates a new row in the database).
  • DeleteObjectButton: It is a push-button with which objects can be deleted. In such cases, the BusinessObject must be set, the BusinessObject specified there will perform the deletion. In such cases, the BusinessObject setting is mandatory and the BusinessObject specified there will perform the deletion.
  • SimpleLinkButton: It is a push-button, which will open the screen specified in the Screen setting.

The individual types are regulated by further settings, and the type narrows the possible settings of the Operator.

/DisplayDefinition/ControlPanel/Controls/Control/Name (String)

With this setting, the name of the filter filed or push-button displayed on the ControlPanel has to be specified.

/DisplayDefinition/ControlPanel/Controls/Control/Operator (String)

The SQL operator used for filtering. The use of operators is not possible with each filter field, for example in case of date range filtering (DateRange) the like operator cannot be used. Their usage is similar to the WHERE operators typically found in the SQL server. Its possible values are:

  • %like%, like%, %like
  • =, <, >, <=, >=, <>
  • in: here the Query node must also be set, which will generate the result set on the right-hand side of the expression.
  • between: it can be used with date ranges (DateRange), where the starting date will replace {0} and the end date will replace {1}.

    <ConnectedColumn>(f.Deadline BETWEEN '{0}' AND '{1} 23:59:59.999')</ConnectedColumn>

/DisplayDefinition/ControlPanel/Controls/Control/Width (Integer)

It specifies the width of the filter field (in pixels). It is optional. Different default values are defined for the different types in the engine.

/DisplayDefinition/ControlPanel/Controls/Control/Caption (String)

Using this setting, we have to specify the caption of the filter field.

/DisplayDefinition/ControlPanel/Controls/Control/ConnectedColumnDefinition (String)

It is the column connected to the filter field. Here a valid SQL expression/or SQL column must be defined, that is based on the SQL statement of the DataDefinition.

<ConnectedColumnDefinition>pep.PeopleID</ConnectedColumnDefinition>

/DisplayDefinition/ControlPanel/Controls/Control/ComboDefinition (String)

It is used only in case of Type = ComboSearch type filter field. With this node, we have to specify the datasource from which the list of selectable items is obtained.

Example

<Control>
    <Name>PortfolioCombo</Name>
    <Type>ComboSearch</Type>
    <Caption>Status</Caption>
    <ConnectedColumnDefinition>p.PortfolioID</ConnectedColumnDefinition>
    <Operator>=</Operator>
    <ComboDefinition>ComboPortfolio</ComboDefinition>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/LookupFilterName (String)

It is an optional setting used only in case of Type = ComboSearch type filter field. If the value set of the referenced drop-down list can be further narrowed by setting a filter, the name of such a filter can be specified in this setting.

Example

<Control>
    <Name>ComboCountry</Name>
    <Type>ComboSearch</Type>
    <Caption>Country</Caption>
    <ConnectedColumnDefinition>c.Country</ConnectedColumnDefinition>
    <Operator>=</Operator>
    <ComboDefinition>ComboFixedValuesLookup</ComboDefinition>
    <LookupFilterName>GroupNum</LookupFilterName>
    <LookupFilterValue>1</LookupFilterValue>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/LookupFilterValue (String)

It is an optional setting used only in case of Type = ComboSearch type filter field. If the value set of the referenced drop-down list can be further narrowed by setting a filter, the value of such a filter can be specified in this setting.

Example

<Control>
    <Name>ComboCountry</Name>
    <Type>ComboSearch</Type>
    <Caption>Country</Caption>
    <ConnectedColumnDefinition>c.Country</ConnectedColumnDefinition>
    <Operator>=</Operator>
    <ComboDefinition>ComboFixedValuesLookup</ComboDefinition>
    <LookupFilterName>GroupNum</LookupFilterName>
    <LookupFilterValue>1</LookupFilterValue>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/IsMultiSelect (Boolean)

It is an optional setting used only in case of Type = ComboSearch type filter field. Using this setting, we can allow that multiple values may be selected from the drop-down list.

/DisplayDefinition/ControlPanel/Controls/Control/ComputedValueList (RuleValueType)

It is an optional setting used only in case of Type = ComboSearch type filter field. This setting is used to compute and narrow a value set; the rule defines a WHERE segment, which it replaces with the 1=1 string in the query in the ComboDefinition.

/DisplayDefinition/ControlPanel/Controls/Control/DataDefinition (String)

This setting is used only in case of Type = TagCloud and Type = QuerySearch type of filter fields.

  • In case of the QuerySearch type, this DataDefinition is used to query the string to be displayed for the ID value (e.g. CompanyID and Name from the Company table).
  • In case of the TagCloud type, this DataDefinition will be the datasource looking up the appearing tags.

Example 1:

<Control>
    <Name>CompanyQuery</Name>
    <Type>QuerySearch</Type>
    <Caption>Company</Caption>
    <ConnectedColumnDefinition>c.CompanyID</ConnectedColumnDefinition>
    <Operator>=</Operator>
    <Screen>ScreenChoiseCompany</Screen>
    <DataDefinition>DataDefinitionCompanyEdit</DataDefinition>
    <KeyColumnDefinition>CompanyID</KeyColumnDefinition>
    <ValueColumn>Name</ValueColumn>
</Control>

**Example 2:

<Control>
    <Name>tagCloud1</Name>
    <Type>TagCloud</Type>
    <Caption>TagCloud</Caption>
    <Width>430</Width>
    <DataDefinition>DataDefinitionDocumentTagCloud</DataDefinition>
    <TagGroupColumn>tagGroup</TagGroupColumn>
    <TagCaptionColumn>tag</TagCaptionColumn>
    <TagValueColumn>count</TagValueColumn>
    <TagIDColumn>tagValue</TagIDColumn>
    <TagSearchControlDefinitionColumn>psearchDef</TagSearchControlDefinitionColumn>
    <DisplayGroupInControl>false</DisplayGroupInControl>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/KeyColumnDefinition (String)

This setting is used only in case of the Type = QuerySearch type filter field. It defines the SQL expression used in the WHERE fragment of the datasource referenced in the DataDefinition to query the value for the ID. In the example it replaces the 1=1 part of the query defined in the DataDefinitionCompanyEdit DataDefinition with the c.CompanyID = '5' (if we are looking for the company with the ID value '5').

Example:

<Control>
    <Name>CompanyQuery</Name>
    <Type>QuerySearch</Type>
    <Caption>Company</Caption>
    <ConnectedColumnDefinition>c.CompanyID</ConnectedColumnDefinition>
    <Operator>=</Operator>
    <Screen>ScreenChoiseCompany</Screen>
    <DataDefinition>DataDefinitionCompanyEdit</DataDefinition>
    <KeyColumnDefinition>c.CompanyID</KeyColumnDefinition>
    <ValueColumn>Name</ValueColumn>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/ValueColumn (String)

This setting is used only in case of the Type = QuerySearch type filter field. It defines the column of the result of the datasource referenced in the DataDefinition which contains the value (to be displayed in the field). In the example the Name column will contain the displayed value (such as Oriana Ltd.)

Example:

<Control>
    <Name>CompanyQuery</Name>
    <Type>QuerySearch</Type>
    <Caption>Company</Caption>
    <ConnectedColumnDefinition>c.CompanyID</ConnectedColumnDefinition>
    <Operator>=</Operator>
    <Screen>ScreenChoiseCompany</Screen>
    <DataDefinition>DataDefinitionCompanyEdit</DataDefinition>
    <KeyColumnDefinition>c.CompanyID</KeyColumnDefinition>
    <ValueColumn>Name</ValueColumn>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/UseNumericRestriction (Enumeration)

This setting is used with TextSearch filter fields to ensure that only numbers may be entered in the filter field. Its value may be: byte, int16, int32, int64 or double. The default value is: int32 (that is, if the setting has a value, but it is none of the above).

/DisplayDefinition/ControlPanel/Controls/Control/UseHTMLEncode (Boolean)

This is a rarely used, technical type of setting. Due to safety reasons, Effector by default converts HTML expressions for a safe storage. Its default value is true, that is, the conversion gets done. In case of a false value, the query is executed using the unencoded form of the characters.

/DisplayDefinition/ControlPanel/Controls/Control/CharacterCounterType (Enumeration)

This setting is used with TextSearch filter fields, its possible values are:

  • None: It is the default value; the filter field has no character counter.
  • Count: It displays the number of characters entered.
  • Remaining: It displays the number of remaining characters.

/DisplayDefinition/ControlPanel/Controls/Control/MaxLength (Integer)

This setting is used with TextSearch filter fields to specify the maximum number of characters entered in the filter field.

/DisplayDefinition/ControlPanel/Controls/Control/IsIndeterminateAllowed (Boolean)

This setting is used only in case of Type = BoolSearch type of filter fields to determine whether the filter field should have three states (checked, not checked and unknown) or two states. The default value is true, that is, the filter field has three states.

/DisplayDefinition/ControlPanel/Controls/Control/ButtonLooksLike (Enumeration)

With this setting, we can adjust the appearance of a button to resemble a different action button. Its values are:

  • Auto: It is the default setting; it practically says that the system should not modify the appearance of the button.
  • SaveButton: The button should have the appearance as if it was the Save button on the form.
  • CancelButton: The button should have the appearance as if it was the Back button on the form.
  • DeleteButton: The button should have the appearance as if it was the Delete button on the form.
  • DeleteObjectButton: The button should have the appearance as if it was the Delete button on the table (in this XML, this should be used).
  • NewObjectButton: The button should have the appearance as if it was the New Object button on the table (in this XML, this can be used).

In the example, a ProcessResultSet button is presented on the interface as if it was a Delete button.

Example:

<Control>
    <Name>DeleteColumn</Name>
    <Type>ActionButton</Type>
    <Caption>Delete column</Caption>
    <ButtonLooksLike>DeleteObjectButton</ButtonLooksLike>
    <OnButtonClick>
        <ActionType>ProcessResultSet</ActionType>
        <RefreshAfterAction>Component</RefreshAfterAction>
        <CloseScreenAfterAction>false</CloseScreenAfterAction>
        <OnlySelectedRows>true</OnlySelectedRows>
        <StoredProcedure>osp_prs_DeleteColumn</StoredProcedure>
    </OnButtonClick>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/Icon (String)

A unique icon can be placed on the button; its value is a special CSS class. In the example, a universal file copy icon is featured before the caption of the Copy button.

Example:

<Control>
    <Name>Copy</Name>
    <Type>ActionButton</Type>
    <Caption>Copy</Caption>
    <Icon>fa fa-files-o</Icon>
    <OnButtonClick>
        <ActionType>ProcessResultSet</ActionType>
        <RefreshAfterAction>Screen</RefreshAfterAction>
        <CloseScreenAfterAction>false</CloseScreenAfterAction>
        <OnlySelectedRows>true</OnlySelectedRows>
        <StoredProcedure>osp_FSYS_ES_prs_ScreenCopy</StoredProcedure>
    </OnButtonClick>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/Screen (String)

This is a mandatory setting used in case of the Type = NewObjectButton, Type = SimpleLinkButton and Type = QuerySearch filter fields.

The name of the screen (or the value selection window, in case of a QuerySearch) that pops up when pressing the button (it does not have to be specified in the MinorMenu set in the ReferencedMinorMenu node).

Example 1:

<Control>
    <Name>CompanyQuery</Name>
    <Type>QuerySearch</Type>
    <Caption>Company</Caption>
    <ConnectedColumnDefinition>c.CompanyID</ConnectedColumnDefinition>
    <Operator>=</Operator>
    <Screen>ScreenChoiseCompany</Screen>
    <DataDefinition>DataDefinitionCompanyEdit</DataDefinition>
    <KeyColumnDefinition>c.CompanyID</KeyColumnDefinition>
    <ValueColumn>Name</ValueColumn>
</Control>

Example 2:

<Control>
    <Name>NewDocument</Name>
    <Type>NewObjectButton</Type>
    <Caption>New</Caption>
    <ReferencedMinorMenu>MMExample</ReferencedMinorMenu>
    <Screen>ScreenDocument</Screen>
    <BusinessObject>BusinessObjectDocument</BusinessObject>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/ReferencedMinorMenu (String)

It is an optional setting used to specify the MinorMenu whose name the pop-up window will use as a reference in certain functions. This can be used with QuerySearch and NewObjectButton types.

Example:

<Control>
    <Name>NewDocument</Name>
    <Type>NewObjectButton</Type>
    <Caption>New</Caption>
    <ReferencedMinorMenu>MMExample</ReferencedMinorMenu>
    <Screen>ScreenDocument</Screen>
    <BusinessObject>BusinessObjectDocument</BusinessObject>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/Target (String)

This is an optional setting used to set that the screen to be opened will be displayed in a new window (tab) (in case of the NewObjectButton and SimpleLinkButton types). To open a screen in a new window, the _blank value should be used. It works the same way as setting the target attribute on the HTML a tag.

Example

<Control>
    <Name>NewCompany</Name>
    <Type>NewObjectButton</Type>
    <Caption>New</Caption>
    <ReferencedMinorMenu>MMExample</ReferencedMinorMenu>
    <Screen>ScreenCompany</Screen>
    <BusinessObject>BusinessObjectCompany</BusinessObject>
    <Target>_blank</Target>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/BusinessObject (String)

This is a mandatory setting used with filter fields where Type = NewObjectButton and Type = DeleteObjectButton. In case of the NewObjectButton, we need to enter the name of the BusinessObject whose possible subtypes should be selected from. With the DeleteObjectButton, we need to set the name of the BusinessObject that will carry out the deletion, and for a precise identification, we also need to set the idColumn to specify the column of the table (or card list) which contains the unique ID.

Example 1:

<Control>
    <Name>NewDocument</Name>
    <Type>NewObjectButton</Type>
    <Caption>New</Caption>
    <ReferencedMinorMenu>MMExample</ReferencedMinorMenu>
    <Screen>ScreenDocument</Screen>
    <BusinessObject>BusinessObjectDocument</BusinessObject>
</Control>

Example 2:

<Control>
    <Name>DeleteDocument</Name>
    <Type>DeleteObjectButton</Type>
    <Caption>Delete</Caption>
    <BusinessObject idColumn="DocumentID">BusinessObjectDocument</BusinessObject>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick

Under this collection tag, further settings can be defined for the push-buttons.

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/ActionType (Enumeration)

  • OpenUrl: With this button we open a URL in a new window.
  • Outer and Report: Using these buttons, we want to call a server-side .dll function. There is no longer a difference between the two (in case of using new interfaces).
  • Export: This button will use the built-in export function.
  • ProcessResultSet: With this button, we call a stored procedure, which will carry out some type of task. This is the ProcessResultSet function (Fixed parameters on the stored procedure, tables used for fixed data exchange ....)
  • GenerateDocument: With this button the built-in document creating function will be called.
  • ActionButtonChain: With this button we can simulate the sequential pressing of several other buttons.

Example 1:

<Control>
    <Name>prs1</Name>
    <Type>ActionButton</Type>
    <Caption>ProcessResultSet OnlySelectedRows</Caption>
    <OnButtonClick>
        <ActionType>ProcessResultSet</ActionType>
        <OnlySelectedRows>true</OnlySelectedRows>
        <StoredProcedure>osp_prs_RT_ProcessResultSet</StoredProcedure>
    </OnButtonClick>
</Control>

Example 2:

<Control>
    <Name>export</Name>
    <Type>ActionButton</Type>
    <Caption>Excel export</Caption>
    <OnButtonClick>
        <ActionType>Export</ActionType>
    </OnButtonClick>
</Control>

Example 3:

<Control>
    <Name>DLL</Name>
    <Type>ActionButton</Type>
    <Caption>DLL call</Caption>
    <OnButtonClick>
        <ActionType>Outer</ActionType>
        <Module action="CustomerDLLDataGrid" className="orn_ReleaseTest.CustomerDLLDataGrid">[##LocalProgramPath##]\orn_ReleaseTest.dll</Module>
    </OnButtonClick>
</Control>

Example 4:

<Control>
    <Name>Chain1</Name>
    <Type>ActionButton</Type>
    <Caption>ActionButtonChain</Caption>
    <OnButtonClick>
        <ActionType>ActionButtonChain</ActionType>
        <ChainItems>
            <Item id="1">prs1</Item>
            <Item id="2">DLL</Item>
        </ChainItems>
    </OnButtonClick>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/StoredProcedure (String)

This setting is used only if ActionType = ProcessResultSet and ActionType = GenerateDocument. Here we need to set the name of the stored procedure that executes the ProcessResultSet function, prepares the data for document generation and sets the parameters of the function.

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/OnlySelectedRows (Boolean)

This setting is used only if ActionType = ProcessResultSet or ActionType = Outer. The set function will be applied to selected rows only. Its default value is false.

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/RefreshAfterAction (Enumeration)

This setting is used only if ActionType = ProcessResultSet, ActionType = GenerateDocument, ActionType = Report and ActionType = Outer. It defines whether the entire screen or the current component is refreshed after the action is completed. It is optional; its possible values are Component, Screen and None. It defaults to None.

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/CloseScreenAfterAction (Boolean)

This setting is used only if Type = ActionButton. With its help, we can define whether Effector closes the screen once the action is completed. Its default value is false, that is, it will not close the window.

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/Url (String)

This setting is used only if ActionType = OpenUrl,where we need to enter the URL of the website to be opened. Effector will always open the set URL in a new window (tab).

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/UrlWindowOptions (String)

This setting is used only with ActionType = OpenUrl, were we can set the parameters of the pop-up window.

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/ChainItems

This setting is used only with ActionType = ActionButtonChain. Several functions can be stringed to a single button, which means that we can have the same result at the push of one button as though multiple buttons were pressed consecutively on the interface. These settings are joined by this node.

Example:

<Control>
    <Name>Chain1</Name>
    <Type>ActionButton</Type>
    <Caption>ActionButtonChain</Caption>
    <OnButtonClick>
        <ActionType>ActionButtonChain</ActionType>
          <ChainItems>
            <Item id="1">prs1</Item>
            <Item id="2">DLL</Item>
        </ChainItems>
    </OnButtonClick>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/ChainItems/Item (String)

This setting is used only with ActionType = ActionButtonChain, its value is the name of the push-button defined on the ControlPanel which takes part in the chain. The id attribute defines the order (integer).

Example:

<Control>
    <Name>Chain1</Name>
    <Type>ActionButton</Type>
    <Caption>ActionButtonChain</Caption>
    <OnButtonClick>
        <ActionType>ActionButtonChain</ActionType>
          <ChainItems>
            <Item id="1">prs1</Item>
            <Item id="2">DLL</Item>
        </ChainItems>
    </OnButtonClick>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/Module (String)

. This setting is used with ActionType = Outer and ActionType = Report only. Here we can set the parameters of the .dll call.

  • The value of the node is the name and path of the.dll file itself. Effector replaces the string [##LocalProgramPath##] in the path with the bin directory of the relevant website, this way the translated dll file can be copied directly to Effector`s program files.
  • Using the className attribute, we need to define the name of the class that carries out the desired unique function.
  • Using the action attribute, , we can select the action we want to be executed within the function (it is not a systemic setting, the developers have to work out and handle them).

Example:

<Control>
    <Name>DLL</Name>
    <Type>ActionButton</Type>
    <Caption>DLL call</Caption>
    <OnButtonClick>
        <ActionType>Outer</ActionType>
        <Module action="CustomerDLLDataGrid" className="orn_ReleaseTest.CustomerDLLDataGrid">[##LocalProgramPath##]\orn_ReleaseTest.dll</Module>
    </OnButtonClick>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/DataSources

This setting is used in case of ActionType = Export only. Here we can set a datasource different from the current DisplayDefinition.

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/DataSources/DataSource (String)

This setting is used in case of ActionType = Export only. Here we can set a datasource different from the current DisplayDefinition. The value of the node is the name of the DisplayDefinition which we want to export. Using the filterType attribute, we can define whether the incoming or the outgoing filters are used for filtering. The value of the attribute ca be In or Out, where the default value is Out.

Example:

<Control>
    <Name>exportPeopleCompany</Name>
    <Type>ActionButton</Type>
    <Caption>Excel export (people and companies)</Caption>
    <OnButtonClick>
        <ActionType>Export</ActionType>
        <DataSources>
            <DataSource filterType="Out">DisplayDefinitionPeoples</DataSource>
            <DataSource filterType="Out">DisplayDefinitionCompanies</DataSource>
        </DataSources>
    </OnButtonClick>
</Control>

From each source, a worksheet is generated in the order of listing.

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/ExcelTemplate (String)

This setting is used only if ActionType = Export. Here we can specify an excel template, where the data is exported to. The path of the template has to be set in the ExcelTemplate table. Using the firstCell attribute, we can define the cell of individual worksheets where Effector should start to insert data. These are cell references, divided by commas. By default, the system starts filling cells from cell A2 on each worksheet.

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/DefaultExportFormat (Enumeration)

This setting is used only if ActionType = Export to define the default selected format on the selection screen of the export parameters. Its value may be CSV, Excel97To2003 or Xlsx.

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/DefaultExportType (Enumeration)

This setting is used only if ActionType = Export to specify the default export range to be selected on the export parameter selection screen. Its value may be All, Actual or OnlySelected; it defaults to All.

/DisplayDefinition/ControlPanel/Controls/Control/OnButtonClick/ExportFillMethod (Enumeration)

This setting is used only if ActionType = Export to regulate the method of entering data to fill an Excel template. Its value can be Insert or Overwrite; the default value is Insert. In case of the Insert setting, Effector inserts a new Excel row for each data row, while in case of the Overwrite, it overwrites the content of cells (it is practical when a given cell range has to filled with data).

/DisplayDefinition/ControlPanel/Controls/Control/Question

This setting is used with ActionButton controls. It opens a dialogue box before the function is executed. It is optional. The type attribute specifies the buttons displayed in the pop-up dialogue box. Its possible values are:

  • OkCancel: The pop-up window features an "Ok" and a "Cancel" button. Upon pressing the "Ok" button, the operation continues, whereas when the "Cancel" button is pressed, nothing happens.
  • Ok: It opens an informative window before saving.
  • Cancel: It also opens an informative window, but it also prevents saving.
  • Custom: Using the Button setting, we can define further buttons to be displayed in the dialogue box. In this case, the ProcessResultSet function gets the ID of the selected button.

Example:

 <Question type="Custom">
      <Condition type="Constant" return="boolean" default="false">true</Condition>
      <Message type="Constant" return="string" default="">Please select</Message>
      <Buttons><![CDATA[{"option1": { "className": "btn-primary", "label": "Option 1" }, "option2": { "className": "btn-info", "label": " Option 2" }, "cancel": { "className": "btn-danger", "label": "Cancel", "cancel": true }}]]></Buttons>
</Question>

/DisplayDefinition/ControlPanel/Controls/Control/Question/Message (RuleValueType)

The rule computing the message to be displayed.

Example:

 <Question type="Custom">
      <Condition type="Constant" return="boolean" default="false">true</Condition>
      <Message type="Constant" return="string" default="">Please select</Message>
      <Buttons><![CDATA[{"option1": { "className": "btn-primary", "label": "Option 1" }, "option2": { "className": "btn-info", "label": " Option 2" }, "cancel": { "className": "btn-danger", "label": "Cancel", "cancel": true }}]]></Buttons>
</Question>

/DisplayDefinition/ControlPanel/Controls/Control/Question/Condition (RuleValueType)

This rule regulates whether the window pops up. If the value of the rule is true, the pop-up window will appear.

Example:

 <Question type="Custom">
      <Condition type="Constant" return="boolean" default="false">true</Condition>
      <Message type="Constant" return="string" default="">Please select</Message>
      <Buttons><![CDATA[{"option1": { "className": "btn-primary", "label": " Option 1" }, "option2": { "className": "btn-info", "label": " Option 2" }, "cancel": { "className": "btn-danger", "label": "Cancel", "cancel": true }}]]></Buttons>
</Question>

/DisplayDefinition/ControlPanel/Controls/Control/Question/Buttons (String)

This setting is used only when type = Custom. A JSON definition has to be specified here. The cancel button must be marked separately with the value "cancel": true.

Example:

 <Question type="Custom">
      <Condition type="Constant" return="boolean" default="false">true</Condition>
      <Message type="Constant" return="string" default="">Please select</Message>
      <Buttons><![CDATA[{"option1": { "className": "btn-primary", "label": " Option 1" }, "option2": { "className": "btn-info", "label": "Option 2" }, "cancel": { "className": "btn-danger", "label": "Cancel", "cancel": true }}]]></Buttons>
</Question>

In the stored procedure, the following few lines indicate which button has been pressed by the user:

DECLARE 
    @clickedButton VARCHAR(100)

SELECT TOP 1 @clickedButton = ClickedQuestionButton FROM ProcessResultSet WHERE ProcessResultSetID = @ProcessResultSetID

When someone clicks on the “Option 2” button in the above example, the option 2 value gets assigned to the @clickedButton.

/DisplayDefinition/ControlPanel/Controls/Control/TagCaptionColumn (String)

This is a setting used only in case of TagCloud type of filters (Type = TagCloud). Here we need to specify the name of the column in the datasource set in the DataDefinition setting (within Control) which contains the tag captions.

Example:

<Control>
    <Name>tagCloud1</Name>
    <Type>TagCloud</Type>
    <Caption>Tag cloud</Caption>
    <DataDefinition>DDTagCloudSample</DataDefinition>
    <TagGroupColumn>tagGroup</TagGroupColumn>
    <TagCaptionColumn>tagCaption</TagCaptionColumn>
    <TagValueColumn>count</TagValueColumn>
    <TagIDColumn>tagID</TagIDColumn>
    <TagPSearchDefinitionColumn>psearchDef</TagPSearchDefinitionColumn>
    <Width>430</Width>
    <DisplayGroupInControl>false</DisplayGroupInControl>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/TagGroupColumn (String)

This is a setting used only in case of TagCloud type of filters (Type = TagCloud). Here we need to specify the name of the column in the datasource set in the DataDefinition setting (within Control) which contains the name of the tag groups.

Example:

<Control>
    <Name>tagCloud1</Name>
    <Type>TagCloud</Type>
    <Caption>Tag cloud</Caption>
    <DataDefinition>DDTagCloudSample</DataDefinition>
    <TagGroupColumn>tagGroup</TagGroupColumn>
    <TagCaptionColumn>tagCaption</TagCaptionColumn>
    <TagValueColumn>count</TagValueColumn>
    <TagIDColumn>tagID</TagIDColumn>
    <TagPSearchDefinitionColumn>psearchDef</TagPSearchDefinitionColumn>
    <Width>430</Width>
    <DisplayGroupInControl>false</DisplayGroupInControl>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/TagIDColumn (String)

This is a setting used only in case of TagCloud type of filters (Type = TagCloud). Here we need to specify the name of the column in the datasource set in the DataDefinition setting (within Control) which contains the tags` unique ID (used within the group).

Example:

<Control>
    <Name>tagCloud1</Name>
    <Type>TagCloud</Type>
    <Caption>Tag cloud</Caption>
    <DataDefinition>DDTagCloudSample</DataDefinition>
    <TagGroupColumn>tagGroup</TagGroupColumn>
    <TagCaptionColumn>tagCaption</TagCaptionColumn>
    <TagValueColumn>count</TagValueColumn>
    <TagIDColumn>tagID</TagIDColumn>
    <TagPSearchDefinitionColumn>psearchDef</TagPSearchDefinitionColumn>
    <Width>430</Width>
    <DisplayGroupInControl>false</DisplayGroupInControl>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/TagValueColumn (String)

This is a setting used only in case of TagCloud type of filters (Type = TagCloud). Here we need to specify the name of the column in the datasource set in the DataDefinition setting (within Control) which contains the value of the counter displayed next to the tag.

Example:

<Control>
    <Name>tagCloud1</Name>
    <Type>TagCloud</Type>
    <Caption>Tag cloud</Caption>
    <DataDefinition>DDTagCloudSample</DataDefinition>
    <TagGroupColumn>tagGroup</TagGroupColumn>
    <TagCaptionColumn>tagCaption</TagCaptionColumn>
    <TagValueColumn>count</TagValueColumn>
    <TagIDColumn>tagID</TagIDColumn>
    <TagPSearchDefinitionColumn>psearchDef</TagPSearchDefinitionColumn>
    <Width>430</Width>
    <DisplayGroupInControl>false</DisplayGroupInControl>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/TagSearchControlDefinitionColumn (String)

This is a setting used only in case of TagCloud type of filters (Type = TagCloud). Here we need to specify the name of the column in the datasource set in the DataDefinition setting (within Control) which defines a ControlPanel Control for filtering.

Example:

<Control>
    <Name>tagCloud1</Name>
    <Type>TagCloud</Type>
    <Caption>Tag cloud</Caption>
    <DataDefinition>DDTagCloudSample</DataDefinition>
    <TagGroupColumn>tagGroup</TagGroupColumn>
    <TagCaptionColumn>tagCaption</TagCaptionColumn>
    <TagValueColumn>count</TagValueColumn>
    <TagIDColumn>tagID</TagIDColumn>
    <TagPSearchDefinitionColumn>psearchDef</TagPSearchDefinitionColumn>
    <Width>430</Width>
    <DisplayGroupInControl>false</DisplayGroupInControl>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/DisplayGroupInControl (Boolean)

This is a setting used only in case of TagCloud type of filters (Type = TagCloud). Its default value is true. If its velue is false, the control will not indicate from which groups the active tags have been selected.

Example:

<Control>
    <Name>tagCloud1</Name>
    <Type>TagCloud</Type>
    <Caption>Tag cloud</Caption>
    <DataDefinition>DDTagCloudSample</DataDefinition>
    <TagGroupColumn>tagGroup</TagGroupColumn>
    <TagCaptionColumn>tagCaption</TagCaptionColumn>
    <TagValueColumn>count</TagValueColumn>
    <TagIDColumn>tagID</TagIDColumn>
    <TagPSearchDefinitionColumn>psearchDef</TagPSearchDefinitionColumn>
    <Width>430</Width>
    <DisplayGroupInControl>false</DisplayGroupInControl>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/Query (String)

This element is used only with the in operator. Here an SQL WHERE expression has to entered, which provide the right-hand side of the statement to be evaluated in connection with the column specified in the ConnectedColumnDefinition. If the value of the Query contains the string #param#, it will be replaced with the value of the ControlPanel Control. Typically, it is used for filtering the SELECT statement in the Query node.**

<Control>
    <Name>ComboBoxSample</Name>
    <Type>ComboSearch</Type>
    <ComboDefinition>ComboSample</ComboDefinition>
    <Caption>Sample Caption</Caption>
    <ConnectedColumnDefinition>sampleTable.SampleField</ConnectedColumnDefinition>
    <Operator>in</Operator>
    <Query>
        (SELECT PeopleID
        FROM People WITH (NOLOCK)
        WHERE PeopleID = '#param#')
    </Query>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/Collation (String)

It is interpreted in case of free text filter fields. We use it when we want to filter the database field based on a Collation different from the default setting. It is optional.

/DisplayDefinition/ControlPanel/Controls/Control/DisplayOverColumn (String)

If we want to display the control under the header of a table column instead of the ControlPanel, we need to set this node. Its value is the name attribute of the column under whose header we want to display the control. It is optional.

/DisplayDefinition/ControlPanel/Controls/Control/DefaultValue (RuleValueType)

It is the default value of the control. Optional.

Example:

<Control>
    <Name>ObjectTypeText</Name>
    <Type>TextSearch</Type>
    <Caption>ObjectType</Caption>
    <ConnectedColumnDefinition>p.ObjectType</ConnectedColumnDefinition>
    <Operator>=</Operator>
    <Visible type="Constant" return="boolean" default="false">false</Visible>
    <DefaultValue type="Constant" return="string" default="">Test</DefaultValue>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/SessionValue (RuleValueType)

Using this setting, we can define an icon (Home) on the control which, when clicked on, inserts the value specified in this rule into the control. If it is not set, the icon is absent from the control.

Example

<Control>
    <Name>FelelosComboBox</Name>
    <Type>ComboSearch</Type>
    <Caption>User</Caption>
    <ConnectedColumnDefinition>OWNER</ConnectedColumnDefinition>
    <Operator>=</Operator>
    <SessionValue type="Constant" return="int" default="0">[##Session.UserID##]</SessionValue>
    <ComboDefinition>ComboUsers</ComboDefinition>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/Visible (RuleValueType)

It defines the visibility of the control. The default value of the rule is true, that is, it is visible.

/DisplayDefinition/ControlPanel/Controls/Control/Required (RuleValueType)

Filling the control is mandatory. The default value of the rule is false, that is, it is not mandatory.

/DisplayDefinition/ControlPanel/Controls/Control/ComputedValue (RuleValueType)

It is the computed value of the control. Optional.

Example

<Control>
    <Name>WorkflowText</Name>
    <Type>TextSearch</Type>
    <Caption>Workflow ID</Caption>
    <ConnectedColumnDefinition>e.WorkflowID</ConnectedColumnDefinition>
    <Operator>=</Operator>
    <Visible type="Constant" return="boolean" default="false">false</Visible>
    <DefaultValue type="Constant" return="string" default="">[##Filter.Workflow_ID##]</DefaultValue>
    <ComputedValue type="Constant" return="string" default="">[##Filter.Workflow_ID##]</ComputedValue>
</Control>

/DisplayDefinition/ControlPanel/Controls/Control/Readonly (RuleValueType)

This setting regulates the editability of the control. The default value of the rule is false, that is, it is editable.

/DisplayDefinition/ControlPanel/Controls/Control/Tooltip (RuleValueType)

Using this rule, we can define the tooltip text. The tooltip icon (or in case of a button the tooltip gets replaced) appears only when the rule returns a non-empty string.

/DisplayDefinition/ControlPanel/Controls/Control/Warning (RuleValueType)

This rule works similarly to the Tooltip rule, with the only difference that here the icon is more prominent.

/DisplayDefinition/ControlPanel/Controls/Control/PlaceHolder (RuleValueType)

Text inserted into the control field when no value is entered. Optional.

/DisplayDefinition/Links

It is the node clustering the definitions of links.

/DisplayDefinition/Links/Link

It is the node joining the definition of a link.

/DisplayDefinition/Links/Link/Type (Enumeration)

This setting is used to specify the type of a Link. It is optional, its default value is Exists. Its values may be:

  • Exists: It opens the screen defined in the Screen node with an outgoing filter calculated using the ColumnName column.
  • NewOrExists: It is the same as the Exists except, if the value is zero, it opens the given screen while generating a new object (as if the NewObjectButton was pressed).
  • New: It is similar to the NewOrExists, but in this case it will always open the given screen in new data entry mode.
  • ProcessResultSet: When the link is clicked, it allows the running of a ProcessResultSet defined on the ControlPanel. In the ProcessResultSetControl node, we need to set the Name value of the given Control.
  • OpenUrl: When clicked on, the link opens the URL set in the column`s value.

/DisplayDefinition/Links/Link/ColumnName (String)

This is the ID of the column (the Name attribute of the /DisplayDefinition/Columns/Column node), where the link appears.

/DisplayDefinition/Links/Link/ReferencedMinorMenu (String)

It is an optional setting used to specify the MinorMenu whose name the pop-up window will use as reference in certain functions.

<Link>
    <ColumnName>SampleColumn</ColumnName>
    <ReferencedMinorMenu>MMSample</ReferencedMinorMenu>
    <Screen>ScreenSample</Screen>
</Link>

/DisplayDefinition/Links/Link/Screen (String)

The name of the screen that pops up when the link is clicked. (It does not have to be set in the MinorMenu specified in the ReferencedMinorMenu node).

<Link>
    <ColumnName>SampleColumn</ColumnName>
    <ReferencedMinorMenu>MMSample</ReferencedMinorMenu>
    <Screen>ScreenSample</Screen>
</Link>

/DisplayDefinition/Links/Link/Target (String)

An optional setting used to set that the screen to be opened will be displayed in a new window (tab). To open a screen in a new window, the _blank value should be used. It works the same way as setting the target attribute on the HTML a tag.

Example

<Link>
    <ColumnName>Name</ColumnName>
    <Screen>ScreenCompany</Screen>
    <ReferencedMinorMenu>MMExample</ReferencedMinorMenu>
    <Target>_blank</Target>
</Link>

/DisplayDefinition/Links/Link/ProcessResultSetControl (String)

If the value of the Type is ProcessResultSet, in this node we need to set the name of the button defined on the ControlPanel that will execute the ProcessResultSet function.

Example

<Link>
    <Type>ProcessResultSet</Type>
    <ColumnName>VisibleCardIcon</ColumnName>
    <ProcessResultSetControl>SetVisibility</ProcessResultSetControl>
</Link>

/DisplayDefinition/Links/Link/ProcessResultSetObjectType (String)

A setting used with ProcessResultSetControl to specify the ObjectType for the ProcessResultSet function. It is a rarely used setting.

/DisplayDefinition/Links/Link/FilterInUrl (String)

It is interpreted only in case of OpenUrl type of links.

A complete xml configuration example

Example

<?xml version="1.0" encoding="ISO-8859-2"?> <DisplayDefinition xmlns="http://effector.hu/schema/ns/DisplayDefinition"> <Caption></Caption> <DataDefinition></DataDefinition> <TemplateURL></TemplateURL> <IsDynamic></IsDynamic> <OutFilterColumn></OutFilterColumn> <UniqueIDColumn></UniqueIDColumn> <UniqueBusinessObject></UniqueBusinessObject> <RowIdentificationMethod></RowIdentificationMethod> <OrderBy direction=""></OrderBy> <PageSize></PageSize> <AlternatePageSize></AlternatePageSize> <AutoRefreshInterval></AutoRefreshInterval> <IsToolbarVisible></IsToolbarVisible> <ViewType></ViewType> <AlternateViewType></AlternateViewType> <ToolbarOptions> <IsSelectionTypeTogglerVisible></IsSelectionTypeTogglerVisible> <IsCardGroupLayoutChangeEnabled></IsCardGroupLayoutChangeEnabled> <IsOpenAllColumnsButtonVisible></IsOpenAllColumnsButtonVisible> <IsRowNumberTogglerVisible></IsRowNumberTogglerVisible> <IsToolsTogglerVisible></IsToolsTogglerVisible> <TrashCanActionControl></TrashCanActionControl> <DefaultSelectionType></DefaultSelectionType> </ToolbarOptions> <TableViewOptions> <IsRowNumberVisible></IsRowNumberVisible> <Summaries> <Summary column="" type=""></Summary> </Summaries> <IsDeleteToolVisible actionControl=""></IsDeleteToolVisible> <IsCardPreviewToolVisible></IsCardPreviewToolVisible> <IsEditToolVisible clickedColumn=""></IsEditToolVisible> <IsSimpleFilterEnabled></IsSimpleFilterEnabled> <IsPinningEnabled></IsPinningEnabled> <ColumnGroups excludedColumnsGroupCaption=""> <ColumnGroup name=""> <Caption></Caption> </ColumnGroup> </ColumnGroups> <GroupBy direction=""></GroupBy> <HeaderHeight></HeaderHeight> <ColumnCaptions sourceType=""> <Database> <SelectionString type=""></SelectionString> </Database> <FixedValues> <Caption columnName=""></Caption> </FixedValues> </ColumnCaptions> <IsMultilineRowsEnabled minLineNumber="" maxLineNumber=""></IsMultilineRowsEnabled> </TableViewOptions> <TransposedTableViewOptions> <ColumnCaptions sourceType=""> <Database> <SelectionString type=""></SelectionString> </Database> <FixedValues> <Caption columnName=""></Caption> </FixedValues> </ColumnCaptions> </TransposedTableViewOptions> <HTMLTemplates> <HTMLTemplate when="" is="" width="" height="" isTemplateURL=""></HTMLTemplate> </HTMLTemplates> <CardViewOptions> <IsAnimationEnabled></IsAnimationEnabled> <DragAndDropControlName></DragAndDropControlName> <CardClickControlName></CardClickControlName> <IsGroupingEnabled></IsGroupingEnabled> <IsSortingEnabled></IsSortingEnabled> <GraphByColumns></GraphByColumns> <GroupCssClassList></GroupCssClassList> <CssFloat></CssFloat> <GroupLayout></GroupLayout> <ShowGroupElementCount></ShowGroupElementCount> <GroupBy direction=""></GroupBy> </CardViewOptions> <CardMatrixViewOptions> <IsAnimationEnabled></IsAnimationEnabled> <DragAndDropControlName></DragAndDropControlName> <CardClickControlName></CardClickControlName> <ColumnCount></ColumnCount> <WidthColumn></WidthColumn> <HeightColumn></HeightColumn> </CardMatrixViewOptions> <TreeViewOptions> <ParentIDColumn></ParentIDColumn> <IDColumn></IDColumn> </TreeViewOptions> <CalendarViewOptions> <StartDateColumn></StartDateColumn> <EndDateColumn></EndDateColumn> <NewObjectButtonName></NewObjectButtonName> <DateRangeControlName></DateRangeControlName> <StartHour></StartHour> <EndHour></EndHour> </CalendarViewOptions> <Columns> <Column name=""> <DisallowGrouping></DisallowGrouping> <DisallowSorting></DisallowSorting> <IsPinned></IsPinned> <IsMultiline></IsMultiline> <Format precision=""></Format> <Caption></Caption> <HeaderCssClass></HeaderCssClass> <CellCssClassColumn></CellCssClassColumn> <InplaceEditControl> <Type></Type> <Required></Required> <KeyColumn></KeyColumn> <ComboDefinition></ComboDefinition> <LookupFilterName></LookupFilterName> <LookupFilterValue></LookupFilterValue> <ComputedValueList></ComputedValueList> <Mask></Mask> <IsMultiline height=""></IsMultiline> <Height></Height> <FieldProperties allowDBNull="" maxLength="" type=""></FieldProperties> </InplaceEditControl> <Visible></Visible> <Readonly></Readonly> <Width></Width> <ColumnGroupName></ColumnGroupName> </Column> </Columns> <ControlPanel> <LayoutType>Vertical</LayoutType> <UseIcons>false</UseIcons> <ManualSearchTriggering></ManualSearchTriggering> <Controls> <!— Possible setting in case of TextSearch --> <Control> <Type>TextSearch</Type> <Name></Name> <Operator></Operator> <Width></Width> <Caption></Caption> <ConnectedColumnDefinition></ConnectedColumnDefinition> <UseNumericRestriction></UseNumericRestriction> <UseHTMLEncode></UseHTMLEncode> <CharacterCounterType></CharacterCounterType> <MaxLength></MaxLength> <Query></Query> <Collation></Collation> <DisplayOverColumn></DisplayOverColumn> <DefaultValue></DefaultValue> <SessionValue></SessionValue> <Visible></Visible> <Required></Required> <ComputedValue></ComputedValue> <Readonly></Readonly> <Tooltip></Tooltip> <Warning></Warning> <PlaceHolder></PlaceHolder> </Control> <!-- Possible setting in case of TextSearch --> <Control> <Type>ComboSearch</Type> <Name></Name> <Operator></Operator> <Width></Width> <Caption></Caption> <ConnectedColumnDefinition></ConnectedColumnDefinition> <ComboDefinition></ComboDefinition> <IsMultiSelect></IsMultiSelect> <ComputedValueList></ComputedValueList> <Query></Query> <Collation></Collation> <DisplayOverColumn></DisplayOverColumn> <DefaultValue></DefaultValue> <SessionValue></SessionValue> <Visible></Visible> <Required></Required> <ComputedValue></ComputedValue> <Readonly></Readonly> <Tooltip></Tooltip> <Warning></Warning> <PlaceHolder></PlaceHolder> </Control> <!—Possible settings in case of BoolSearch --> <Control> <Type>BoolSearch</Type> <Name></Name> <Operator></Operator> <Width></Width> <Caption></Caption> <ConnectedColumnDefinition></ConnectedColumnDefinition> <IsIndeterminateAllowed></IsIndeterminateAllowed> <DisplayOverColumn></DisplayOverColumn> <DefaultValue></DefaultValue> <Visible></Visible> <ComputedValue></ComputedValue> <Readonly></Readonly> </Control> <!-- Possible settings in case of QuerySearch --> <Control> <Type>QuerySearch</Type> <Name></Name> <Operator></Operator> <Width></Width> <Caption></Caption> <ConnectedColumnDefinition></ConnectedColumnDefinition> <DataDefinition></DataDefinition> <KeyColumnDefinition></KeyColumnDefinition> <ValueColumn></ValueColumn> <DisplayOverColumn></DisplayOverColumn> <DefaultValue></DefaultValue> <SessionValue></SessionValue> <Visible></Visible> <Required></Required> <ComputedValue></ComputedValue> <Readonly></Readonly> <Tooltip></Tooltip> <Warning></Warning> <PlaceHolder></PlaceHolder> </Control> <!-- Possible settings in case of DateSearch --> <Control> <Type>DateSearch</Type> <Name></Name> <Operator></Operator> <Width></Width> <Caption></Caption> <ConnectedColumnDefinition></ConnectedColumnDefinition> <DisplayOverColumn></DisplayOverColumn> <DefaultValue></DefaultValue> <SessionValue></SessionValue> <Visible></Visible> <Required></Required> <ComputedValue></ComputedValue> <Readonly></Readonly> <Tooltip></Tooltip> <Warning></Warning> <PlaceHolder></PlaceHolder> </Control> <!-- Possible settings in case of DateRange --> <Control> <Type>DateRange</Type> <Name></Name> <Operator></Operator> <Width></Width> <Caption></Caption> <ConnectedColumnDefinition></ConnectedColumnDefinition> <ComboDefinition></ComboDefinition> <ComputedValueList></ComputedValueList> <DisplayOverColumn></DisplayOverColumn> <DefaultValue></DefaultValue> <Visible></Visible> <Required></Required> <ComputedValue></ComputedValue> <Readonly></Readonly> <PlaceHolder></PlaceHolder> </Control> <!-- Possible settings in case of TagCloud --> <Control> <Type>TagCloud</Type> <Name></Name> <Operator></Operator> <Width></Width> <Caption></Caption> <ConnectedColumnDefinition></ConnectedColumnDefinition> <DataDefinition></DataDefinition> <TagCaptionColumn></TagCaptionColumn> <TagGroupColumn></TagGroupColumn> <TagIDColumn></TagIDColumn> <TagValueColumn></TagValueColumn> <TagSearchControlDefinitionColumn></TagSearchControlDefinitionColumn> <DisplayGroupInControl></DisplayGroupInControl> <DisplayOverColumn></DisplayOverColumn> <Visible></Visible> <Readonly></Readonly> <PlaceHolder></PlaceHolder> </Control> <!-- Possible settings in case of NewObjectButton --> <Control> <Type>NewObjectButton</Type> <Name></Name> <Width></Width> <Caption></Caption> <ButtonLooksLike></ButtonLooksLike> <Icon></Icon> <Screen></Screen> <ReferencedMinorMenu></ReferencedMinorMenu> <Target></Target> <BusinessObject></BusinessObject> <Question type=""> <Message></Message> <Condition></Condition> </Question> <Visible></Visible> <Readonly></Readonly> <Tooltip></Tooltip> </Control> <!-- Possible settings in case of DeleteObjectButton --> <Control> <Type>DeleteObjectButton</Type> <Name></Name> <Width></Width> <Caption></Caption> <ButtonLooksLike></ButtonLooksLike> <Icon></Icon> <BusinessObject idColumn=""></BusinessObject> <Question type=""> <Message></Message> <Condition></Condition> </Question> <Visible></Visible> <Readonly></Readonly> <Tooltip></Tooltip> </Control> <!-- Possible settings in case of SimpleLinkButton --> <Control> <Type>SimpleLinkButton</Type> <Name></Name> <Width></Width> <Caption></Caption> <ButtonLooksLike></ButtonLooksLike> <Icon></Icon> <Screen></Screen> <ReferencedMinorMenu></ReferencedMinorMenu> <Target></Target> <Question type=""> <Message></Message> <Condition></Condition> </Question> <Visible></Visible> <Readonly></Readonly> <Tooltip></Tooltip> </Control> <!-- Possible settings in case of ActionButton:Export --> <Control> <Type>ActionButton</Type> <Name></Name> <Width></Width> <Caption></Caption> <ButtonLooksLike></ButtonLooksLike> <Icon></Icon> <Question type=""> <Message></Message> <Condition></Condition> </Question> <OnButtonClick> <ActionType>Export</ActionType> <DataSources> <DataSource filterType=""></DataSource> </DataSources> <ExcelTemplate firstCell=""></ExcelTemplate> <DefaultExportFormat></DefaultExportFormat> <DefaultExportType></DefaultExportType> <ExportFillMethod></ExportFillMethod> </OnButtonClick> <Visible></Visible> <Readonly></Readonly> <Tooltip></Tooltip> </Control> <!-- Possible settings in case of ActionButton:ProcessResultSet --> <Control> <Type>ActionButton</Type> <Name></Name> <Width></Width> <Caption></Caption> <ButtonLooksLike></ButtonLooksLike> <Icon></Icon> <Question type=""> <Message></Message> <Condition></Condition> <Buttons></Buttons> </Question> <OnButtonClick> <ActionType>ProcessResultSet</ActionType> <StoredProcedure></StoredProcedure> <OnlySelectedRows></OnlySelectedRows> <RefreshAfterAction></RefreshAfterAction> <CloseScreenAfterAction></CloseScreenAfterAction> </OnButtonClick> <Visible></Visible> <Readonly></Readonly> <Tooltip></Tooltip> </Control> <!-- Possible settings in case of ActionButton:GenerateDocument --> <Control> <Type>ActionButton</Type> <Name></Name> <Width></Width> <Caption></Caption> <ButtonLooksLike></ButtonLooksLike> <Icon></Icon> <Question type=""> <Message></Message> <Condition></Condition> <Buttons></Buttons> </Question> <OnButtonClick> <ActionType>GenerateDocument</ActionType> <StoredProcedure></StoredProcedure> <OnlySelectedRows></OnlySelectedRows> <RefreshAfterAction></RefreshAfterAction> <CloseScreenAfterAction></CloseScreenAfterAction> </OnButtonClick> <Visible></Visible> <Readonly></Readonly> <Tooltip></Tooltip> </Control> <!-- Possible settings in case of ActionButton:OpenUrl --> <Control> <Type>ActionButton</Type> <Name></Name> <Width></Width> <Caption></Caption> <ButtonLooksLike></ButtonLooksLike> <Icon></Icon> <Question type=""> <Message></Message> <Condition></Condition> </Question> <OnButtonClick> <ActionType>OpenUrl</ActionType> <Url></Url> <UrlWindowOptions></UrlWindowOptions> </OnButtonClick> <Visible></Visible> <Readonly></Readonly> <Tooltip></Tooltip> </Control> <!-- Possible settings in case of ActionButton:Outer --> <Control> <Type>ActionButton</Type> <Name></Name> <Width></Width> <Caption></Caption> <ButtonLooksLike></ButtonLooksLike> <Icon></Icon> <Question type=""> <Message></Message> <Condition></Condition> </Question> <OnButtonClick> <ActionType>Outer</ActionType> <Module className="" action=""></Module> </OnButtonClick> <Visible></Visible> <Readonly></Readonly> <Tooltip></Tooltip> </Control> <!-- Possible settings in case of ActionButton:ActionButtonChain --> <Control> <Type>ActionButton</Type> <Name></Name> <Width></Width> <Caption></Caption> <ButtonLooksLike></ButtonLooksLike> <Icon></Icon> <Question type=""> <Message></Message> <Condition></Condition> </Question> <OnButtonClick> <ActionType>ActionButtonChain</ActionType> <ChainItems> <Item id=""></Item> </ChainItems> </OnButtonClick> <Visible></Visible> <Readonly></Readonly> <Tooltip></Tooltip> </Control> <!-- Possible settings in case of ActionButton:Print --> <Control> <Type>ActionButton</Type> <Name></Name> <Width></Width> <Caption></Caption> <ButtonLooksLike></ButtonLooksLike> <Icon></Icon> <Question type=""> <Message></Message> <Condition></Condition> </Question> <Visible></Visible> <Readonly></Readonly> <Tooltip></Tooltip> </Control> </Controls> </ControlPanel> <Links> <Link> <Type></Type> <ColumnName></ColumnName> <ReferencedMinorMenu></ReferencedMinorMenu> <Screen></Screen> <Target></Target> <ProcessResultSetControl></ProcessResultSetControl> <ProcessResultSetObjectType></ProcessResultSetObjectType> <FilterInUrl></FilterInUrl> </Link> </Links> </DisplayDefinition>

  • Last update: 20 weeks 3 days ago
  • Effector