This example demonstrates how to dynamically create a report based on the GridControl at runtime. This means that all filtering, sorting and grouping conditions selected in the grid are also applied in the report. To accomplish this task, it is necessary to create a report with all the necessary bands, bind it to a data source, and adjust all the necessary options. You can use this approach if you need to insert a report based on GridControl into another report.

[Update]
Starting with version 15.2, you can use GridReportManagerService to convert and export GridControl by using XtraReports.

MVVM Framework provides the EventToCommand class that allows delegating event processing logic to the ViewModel level. This example illustrates how to use this functionality to process DXGrid events.

The EventToCommand class provides the PassEventArgsToCommand option that allows passing the corresponding EventArgs as a command parameter. If necessary, you can extract the required information from event arguments and then pass this information as a command parameter. To do this, use the EventArgsConverter.

This example demonstrates how to create a custom function that removes all diacritic symbols from the specified string value. Using the GridView.SubstituteFilter event, this function can be injected into the active grid filter.

The SubstituteFilter event was added in version 2015 vol 1. To accomplish this task in older version, create a custom grid and customize the mechanism of filtering data via the auto filter row. For this, the GridView.RaiseCustomRowFilter method can be overridden. In this method, the cell text and filter string should be normalized via the standard String.Normalize method and then the cell value is processed based on the comparison operator type returned via the OptionsColumnFilter.AutoFilterCondition property.

This example is an illustration of the KA18675: MVC ComboBox Extension - How to implement cascaded combo boxes KB Article. Refer to the Article for an explanation.

This example demonstrates how to show an error message when an attempt to delete a record is cancelled by the RowDeleting event handler.

This example illustrates how to override CopySelectionCommand and PasteSelectionCommand behavior via the IRichEditCommandFactoryService substitution. This approach is based on the How to replace standard XtraRichEdit command with your own custom command example.

Customized CopySelectionCommand contains code for copying selection to the Clipboard in an HTML Clipboard Format (see the HtmlHelper.GetHtmlClipboardFormat() method), which is not implemented by default at the XtraRichEdit source code level. This allows you to copy RichEditControl content and paste it directly to a certain control that can accept HTML-formatted data from the clipboard (e. g. ASPxHtmlEditor). Note that images are embedded into resultant HTML according to the Data URI scheme specification to avoid dependency on the image location (it may not be resolved by the target application). Refer to the Building a mail application with the RichEditControl example to learn more on this approach.

As for customized PasteSelectionCommand, it simply retrieves plain (unformatted) text from the clipboard and pastes this text into the RichEditControl.

See Also:
SubDocument.GetText Method
SubDocument.GetRtfText Method
SubDocument.GetHtmlText Method

It's necessary to respecify templates corresponding to the defined resource keys. The dock zone and dock hint elements are placed in the DockVisualizerThemeKey. The resource keys for the dock zone and the left dock hint are DockZone and Left keys respectively. These are the keys you should respecify:

<ControlTemplate x:Key="{dxt:DockVisualizerThemeKey ResourceKey=Left}">
<ControlTemplate x:Key="{dxt:DockVisualizerThemeKey ResourceKey=DockZone}">

UPDATED:

Starting with version v2016 vol 1 (v16.1), a built-in combo box editor can operate in callback mode.  You can find detailed steps by clicking the "Show Implementation Details" link below.


For earlier versions:
At this moment, GridView does not support Callback Mode for the built-in combobox editor in ComboBoxDataColumn: GridView - Support callback mode for the built-in editor of the MVCxGridViewColumnType.ComboBox column. However, in some scenarios it is required to use ComboBoxDataColumn in Callback Mode, for instance, when the ComboBox' data source is too large. In this case it is necessary to use templates. This example demonstrates how to implement Callback Mode ComboBox in Edit Form and in Auto Filter Row of the GridView.
See also:
Using Callbacks

This example illustrates how to add a search box to the field list control. 
Our PivotExcelFieldListControl uses the TreeViewFieldsPresenter component to show fields in a tree-like view. In this example, we create a TreeViewFieldsPresenter control descendant and implement the filtering functionality at its level.  The default TreeViewFieldsPresenter is replaced with our descendant via styles.

Important: The provided approach works when fields are grouped via User Folders. In OLAP mode, fields are grouped automatically. If fields are not grouped, PivotGrid uses another control (not TreeViewFieldsPresenter ) to manage hidden fields and custom style is not used.

[C#]
Anexceptionoftype'DevExpress.XtraPivotGrid.Data.OLAPConnectionException' occurredinDevExpress.PivotGrid.v15.1.Core.dllbutwasnothandledinusercodeAdditionalinformation:Couldn'tconnecttotheAnalysisServices.

This code example demonstrates how to implement setting custom margins in the ASPxSpreadSheet.

To test the functionality, choose menu item Margins - Custom Margins, set preferable values and open a document preview using File - Print menu.

UPDATED:
Starting with v15.2, the new Page Setup dialog was introduced, providing a set of print-related options (document orientation, paper size, page order, etc.) and making it possible to set custom page margins (Specify Print Options). See this in action in our Spreadsheet - Printing online demo.

This example demonstrates how to display data from a data source in dxDataGrid created using the AngularJS approach.

See also:
Configure Widget - Angular Approach

This example demonstrates how to create a custom editor inside a column's EdittemTemplate when ASPxGridView is in Batch Edit mode. Since ASPxGridView performs batch editing on the client side, we cannot process or pass values from editors placed inside templates on the server side. Thus, all processing will be performed on the client side. 

You can implement the EditItem template for a column by performing the following steps:

1. Specify a column's EditItemTemplate:

[ASPx]
<dx:GridViewDataColumnFieldName="C1"><EditItemTemplate>
  <dx:ASPxSpinEditID="C1_spinEdit"runat="server"ClientInstanceName="C1spinEdit"Width="100%">
  </dx:ASPxSpinEdit></EditItemTemplate></dx:GridViewDataColumn>

2. Handle the grid's client-side BatchEditStartEditing event to set the grid's cell values to the editor. It is possible to get the focused cell value using the e.rowValues property:

[JavaScript]
       function Grid_BatchEditStartEditing(s, e){           var templateColumn = s.GetColumnByField("C1");           if(!e.rowValues.hasOwnProperty(templateColumn.index))               return;           var cellInfo = e.rowValues[templateColumn.index];            C1spinEdit.SetValue(cellInfo.value);           if(e.focusedColumn === templateColumn)                C1spinEdit.SetFocus();       }

3. Handle the BatchEditEndEditing event to pass a value entered in the editor to the grid's cell:

[JavaScript]
function Grid_BatchEditEndEditing(s, e){           var templateColumn = s.GetColumnByField("C1");           if(!e.rowValues.hasOwnProperty(templateColumn.index))               return;           var cellInfo = e.rowValues[templateColumn.index];            cellInfo.value = C1spinEdit.GetValue();            cellInfo.text = C1spinEdit.GetText();            C1spinEdit.SetValue(null);       }

4. The BatchEditRowValidating event allows validating the grid's cell based on the entered value:

[JavaScript]
function Grid_BatchEditRowValidating(s, e){           var templateColumn = s.GetColumnByField("C1");           var cellValidationInfo = e.validationInfo[templateColumn.index];           if(!cellValidationInfo)return;           var value = cellValidationInfo.value;           if(!ASPxClientUtils.IsExists(value) || ASPxClientUtils.Trim(value) === ""){                cellValidationInfo.isValid = false;                cellValidationInfo.errorText = "C1 is required";           }       }

5. Finally, handle the editor's client-side KeyDown and LostFocus events to emulate the behavior of standard grid editors when an end-user uses a keyboard or mouse:

[JavaScript]
var preventEndEditOnLostFocus = false;function C1spinEdit_KeyDown(s, e){           var keyCode = ASPxClientUtils.GetKeyCode(e.htmlEvent);           if(keyCode === ASPx.Key.Esc){               var cellInfo = grid.batchEditApi.GetEditCellInfo();                window.setTimeout(function(){                    grid.SetFocusedCell(cellInfo.rowVisibleIndex, cellInfo.column.index);               }, 0);                s.GetInputElement().blur();               return;           }           if(keyCode !== ASPx.Key.Tab && keyCode !== ASPx.Key.Enter)return;           var moveActionName = e.htmlEvent.shiftKey ? "MoveFocusBackward" : "MoveFocusForward";           if(grid.batchEditApi[moveActionName]()){                ASPxClientUtils.PreventEventAndBubble(e.htmlEvent);                preventEndEditOnLostFocus = true;           }       }function C1spinEdit_LostFocus(s, e){if(!preventEndEditOnLostFocus)
                grid.batchEditApi.EndEdit();
            preventEndEditOnLostFocus = false;}

See Also:
GridView - Batch Editing - A simple implementation of an EditItem template 

NOTE: Starting from version 16.1, a simpler solution can be implemented based on the How to: Display a Non-Persistent Object's List View from the Navigation article, using a non-persistent object to represent the query result set.

Scenario

Sometimes it is important to show a readonly ListView with custom data obtained from the database, rather than through standard XPO mechanisms, by means of loading entire persistent objects.

While this custom data may include certain properties of your XPO classes, in a general case, it may come from anywhere, including but not limited to, a raw SQL query, stored procedure, database view or a very complex LINQ query returning only a subset of persistent class properties or even custom data fields. While the first scenarios can be solved by mapping a persistent class to a database view, the second group of scenarios is optimal in implementing a custom form/control (check How to show custom forms and controls in XAF (Example) for more details) or a custom CollectionSource.
Here, we will demonstrate how the latter option can be realized to display data from a custom LINQ query using the LINQ to XPO approach.

In particular, we want to show a list of employees with maximum orders:

Steps to implement

1. Include the XAF.LinqToXpo module project in your solution and make sure it builds successfully.

This module is supposed to generate custom ListView nodes in the Application Model with the _Linq suffix so that this ListView uses data returned by a predefined method (see the XPQueryMethod attribute for the ListView node) using LINQ.

To provide this custom ListView with data, a custom CollectionSourceBase class descendant is implemented (see the XAF.LinqToXpo\LinqCollectionSource.xx file). It is enabled for a custom ListView via the XafApplication.CreateCustomCollectionSource event (see the XAF.LinqToXpo\Module.xx file).

2. Invoke the Module Designer for YourSolutionName.Module project and drag and drop the XafLinqToXpoModule component to the Required Modules list (this component should automatically appear in the Visual Studio Toolbox after executing the previous step).

3. Implement the public static methods that accept DevExpress.Xpo.Session as a parameter and return System.Linq.IQueryable as a result in your persistent classes, where required.

Consider the following signature for more clarity: public static System.Linq.IQueryable MethodName(DevExpress.Xpo.Session session);

Within the method body, use the LINQ to XPO approach to return a required data set based on XPQuery<T>. If you want to return a custom property as part of your data set which does not exist within your XPO data model, then include it into the selected part of the query with a custom name (e.g., Employee_Linq, Orders_Sum_Linq, etc.).

Mark these methods with the XAF.LinqToXpo.QueryProjectionsAttribute to specify that comma-separated names of data properties will be included as a query result.

Refer to the NorthwindDemo.Module\PersistentObjects.xx for an example.

4. Invoke the Model Editor for YourSolutionName.Module project and add custom calculated fields with dummy expressions for each specified custom property which is not part of your default XPO data model. Refer to the NorthwindDemo.Module\Model.DesignedDiffs.xafml file for an example.

IMPORTANT NOTES

1. This example uses the Northwind database for testing. You can download the database creation scripts for testing from here.

2. Since a Linq-based ListView may contain custom data sets and not entire persistent objects in a general case, certain standard Controllers are disabled here (e.g., you cannot open a detail form for this data record or create a new object). Refer to the XAF.LinqToXpo\DisableStandardActionsLinqListViewController.xx file for more details.

3. If you want your default ListView to include custom calculated values, then it is possible to use the built-in Custom Fields feature for that purpose.

This example demonstrates how to add a button to the FilterPanel.




To use this solution in your application, execute the following steps:

1. Create a custom GridControl as it is shown at How to create a GridView descendant class and register it for design-time use.
2. Implement all required functionality in the CustomGridViewHandler, CustomGridView, CustomGridFilterPanelPainter classes.


Implementation details

In fact, the buttons are not located in the FilterPanel. They are simply drawn on its surface. Therefore, it is necessary to implement the Click (or MouseDown\Up) event manually and trigger it when required in your scenario. In this example, the Click event is raised when a custom button is clicked. If you need, for instance, to raise this event when the mouse button is released, you can simply update the CustomGridView.UpdateButtonState method. For instance, pass a parameter into this method which will indicate whether or not the CustomGridViewHandler.OnMouseUp event occurs. Then use this parameter in order to determine whether or not the Click event should be raised. 

It is also possible to change the distance between custom buttons, as well as their size. For this, update the CustomGridView.UpdateButtonsRects method as your needs dictate.

See also:
How to add a custom button to a column header in a grid 
GridControl - How to add a check box to a column header

This example demonstrates how to show the number of selected rows in the Pager bar. It is necessary to create a custom PagerBar template for this purpose. This template will contain ASPxLabel that allows showing the number of selected rows and a standard pager created via the ASPxGridViewTemplateReplacement control:

[ASPx]
<PagerBar><table><tr><td><dx:ASPxGridViewTemplateReplacementrunat="server"ReplacementType="Pager"/></td><td><dx:ASPxLabelID="labelInfo"runat="server"Text=""ClientInstanceName="labelInfo"></dx:ASPxLabel></td></tr></table></PagerBar>

We can get the grid's selected row count via the client-side ASPxClientGridView.GetSelectedRowCount method and then set it to ASPxLabel using the label's SetText method:

[JavaScript]
function ShowRowsCount(){
            labelInfo.SetText('Selected rows count: ' + gridView.GetSelectedRowCount());}

The following example shows how to use a Bound Image dashboard item to display a specified image accessible by a predefined URI.

In the latest versions, you can use the ShowFilterPopupDate event to add a custom filter item to the filter dropdown. See the ShowFilterPopupDate topic for additional information and code snippet.

------------------------------------------------------------------------
This example demonstrates how to add the capability to enter "greater than", "less than", and "between" directly from the calendar popup filter list.

To provide this functionality, it is necessary to create a GridControl descendant with a custom MyGridView.

First, override the MyGridView.CreateDateFilterPopup and MyGridView.RaiseFilterPopupDate methods.

[C#]
protectedoverrideDateFilterPopupCreateDateFilterPopup(GridColumncolumn,System.Windows.Forms.ControlownerControl,objectcreator){returnnewMyDateFilterPopup(this,column,ownerControl,creator);}

In the MyGridView.RaiseFilterPopupDate method add required FilterCriteria.

[C#]
protectedoverridevoidRaiseFilterPopupDate(DateFilterPopupfilterPopup,List<FilterDateElement>list){CriteriaOperatorfilter=newBinaryOperator(filterPopup.Column.FieldName,DateTime.Today,BinaryOperatorType.Greater);list.Add(newFilterDateElement(Localizer.Active.GetLocalizedString(StringId.FilterClauseGreater),"",filter));filter=newBinaryOperator(filterPopup.Column.FieldName,DateTime.Today,BinaryOperatorType.Less);list.Add(newFilterDateElement(Localizer.Active.GetLocalizedString(StringId.FilterClauseLess),"",filter));filter=newBetweenOperator(filterPopup.Column.FieldName,DateTime.Today,DateTime.Today);list.Add(newFilterDateElement(Localizer.Active.GetLocalizedString(StringId.FilterClauseBetween),"",filter));base.RaiseFilterPopupDate(filterPopup,list);}

Now, the CreateDateFilterPopup method returns the MyDateFilterPopup object instead of the DateFilterPopup one.

Override the Popup.CreateRepositoryItem method to create additional controls and add handlers for them:

[C#]
protectedoverrideRepositoryItemPopupBaseCreateRepositoryItem(){item=base.CreateRepositoryItem()asRepositoryItemPopupContainerEdit;if(DateFilterControl.Controls.Count> 0){DateCalendar1=CreateCalendar(DateCalendar1,DateCalendar.SelectionStart,DateCalendar.Top,DateCalendar.Left);DateCalendar1.Visible=false;DateCalendar2=CreateCalendar(DateCalendar2,DateCalendar.SelectionStart,DateCalendar1.Top,DateCalendar.Left+DateCalendar1.Width);DateCalendar2.Visible=false;Greater=GetCheckEditByName(Localizer.Active.GetLocalizedString(StringId.FilterClauseGreater));Less=GetCheckEditByName(Localizer.Active.GetLocalizedString(StringId.FilterClauseLess));Between=GetCheckEditByName(Localizer.Active.GetLocalizedString(StringId.FilterClauseBetween));Greater.CheckedChanged+=CheckedChanged;Less.CheckedChanged+=CheckedChanged;Between.CheckedChanged+=CheckedChanged;foreach(ControlctrlinDateFilterControl.Controls){if(ctrlisCheckEdit)if(NotOurControl(ctrlasCheckEdit))(ctrlasCheckEdit).CheckedChanged+=OriginalDateFilterPopup_CheckedChanged;}}returnitem;}

When a custom item's check state changes, update the popup window layout to display the calendar at a required place.

[C#]
voidCheckedChanged(objectsender,EventArgse){if((senderasCheckEdit).Checked){UpdateOurControlCheckedState((senderasCheckEdit).Text);CalcControlsLocation((senderasCheckEdit).Text);this.View.ActiveFilterCriteria=GetFilterCriteriaByControlState();}else{if(DateCalendar1.Visible||DateCalendar2.Visible){ReturnOriginalView();ReturnOriginalControlsLocation();}}}

The size of each GridView's element is calculated by the GridViewInfo class. The instance of the GridViewInfo class, containing information about a specific GridView instance, can be obtained via the GridView.GetViewInfo method. This method is hidden for IntelliSence, but is public and can be called from external code.