This example demonstrates how to allow entering only numbers in dxNumberBox. For this task we need to handle the dxNumberBox.onKeyPress event and check whether the typed symbol is a number. If this is not a number, prevent the default action of the event by calling the preventDefault method of the event object that is passed to the onKeyPress event handler.

See also:
JavaScript RegExp

[JavaScript]
$("#integerContainer").dxNumberBox({
                valueChangeEvent: "keyup",
                onkeyPress: function(e){//this function name is not with the right casing "onKeyPress"var event = e.jQueryEvent,
                        str = String.fromCharCode(event.keyCode);if(!/[0-9]/.test(str))
                        event.preventDefault();}});

The following example demonstrates a workaround that allows you to print and export a Dashboard visual representation as is via the Print Preview dialog.

In this example, the Customer Support dashboard is displayed. You can invoke the Print Preview for the dashboard in one of the two modes, using the Show Preview or Show Paged Preview button. In the first mode, the paper size is adjusted to fit the dashboard. In the second mode, the dashboard gets split across the appropriate number of standard A4 pages.

To accomplish this, we have created a DashboardExporter class that implements the DevExpress.XtraPrinting.IPrintable interface. DashboardExporter instances are mapped to a DashboardViewer when they are created and then passed to the Print Preview thus bringing the dashboard to paper.

The XtraPivotGrid control is exported in a WYSIWYG (What You See Is What You Get) manner. According to this concept, items are exported as is, and this may cause an undesirable result. E.g. If column header width doesn't exactly match the field value width, the additional column will be produced. I'm afraid there is no way to avoid this problem in all cases. Let suppose that there are three Data Fields and only two Row Field. In this case, there is no any way to avoid cell merging without corrupting the layout.

Actually, we recommend turning off header export to avoid this problem. This can be done via the PivotGridOptionsPrint.PrintColumnHeaders, PivotGridOptionsPrint.PrintDataHeaders and PivotGridOptionsPrint.PrintFilterHeaders properties. However, in some cases, field headers may be necessary to describe the current pivot grid layout.

This example demonstrates how to create an ancillary Column Field that will have only one Field Value, which can be used to export a layout description. The PivotGridControl.CustomExportFieldValue event is used to provide a description to this field. Please note that you can generate any necessary string description by customizing the GetLayoutDiscription function.

Update: starting with version 15.1, the new Data-aware Export mode is available: WinForms & ASP.NET Pivot Grid Controls - New Excel Data Export Engine

By default, if you save a layout of LayoutControl, settings of layout items are saved (Save and Restore Layout ). When you load the saved layout, layout items will be created with saved settings only if LayoutControl contains child controls, whose names exist in the saved layout. Otherwise, layout items will not be created. 

This example illustrates how to save settings of the child controls, too. For this, we have created two extension methods: SaveLayoutExToXml and RestoreLayoutExFromXml. These methods allow you to save and load child controls' settings. It makes sense to use these methods if it is necessary to re-create child controls from the saved layout with the saved settings. If a child control with the same name exists in LayoutControl, it will be removed and replaced by a new one retrieved from the saved layout. This approach is based on using a custom XmlXtraSerializer class. 

TreeList allows users to reorder nodes by dragging them with the mouse. If a node was moved from one parent to another, its position will be saved automatically, because it depends on the ParentID column value which is stored in the database. However, when nodes are reordered within the child collection, their position will be reset after the application is closed and opened again, or after reloading data.

To keep nodes positions, it is necessary to add additional column to the datasource to store the node index. In this situation, nodes positions can be restored after loading the data into the TreeList. This task can be accomplished by iterating all the nodes and updating the node index via the TreeList.SetNodeIndex method.

[C#]
voidUpdateNodesPositions(TreeListNodesnodes){List<TreeListNode>ns=newList<TreeListNode>();foreach(TreeListNodeninnodes)ns.Add(n);foreach(TreeListNodeninns){UpdateNodesPositions(n.Nodes);n.TreeList.SetNodeIndex(n,Convert.ToInt32(n.GetValue("Order")));}}

[VB.NET]
PrivateSub UpdateNodesPositions(ByVal nodes As TreeListNodes)Dim ns AsNew List(Of TreeListNode)()ForEach n As TreeListNode In nodes
        ns.Add(n)Next nForEach n As TreeListNode In ns
        UpdateNodesPositions(n.Nodes)
        n.TreeList.SetNodeIndex(n, Convert.ToInt32(n.GetValue("Order")))Next nEndSub

 
Note that the UpdateNodesPositions method should be called after TreeList is populated with data.  It's also necessary to handle the AfterDragNode event and update the "Order" field's values as follows:

[C#]
privatevoidtreeList1_AfterDragNode(objectsender,AfterDragNodeEventArgse){SaveNewRecordPosition(e);}privatevoidSaveNewRecordPosition(NodeEventArgse){varnodes=e.Node.ParentNode==null?e.Node.TreeList.Nodes:e.Node.ParentNode.Nodes;for(vari= 0;i<nodes.Count;i++){nodes[i].SetValue(colSort,i);}}

[VB.NET]
PrivateSub treeList_AfterDragNode(ByVal sender AsObject, ByVal e As AfterDragNodeEventArgs) Handles treeList1.AfterDragNode
            SaveNewRecordPosition(e)
        EndSubPrivateSub SaveNewRecordPosition(ByVal e As NodeEventArgs)
            Dim nodes = If(e.Node.ParentNode IsNothing, e.Node.TreeList.Nodes, e.Node.ParentNode.Nodes)
            For i = 0 To nodes.Count - 1
                nodes(i).SetValue(colSort, i)
            Next i
        EndSub

This example demonstrates how to provide an event that is raised as soon as a grid layout is changed.

In this example, we have created a GridLayoutHelper class that handles changes of the GridControl object's necessary properties and columns, and raises a custom event in its handlers.

This class can be easily attached to the GridControl object in the following manner:

[XAML]
<dxg:GridControlx:Name="grid"AutoPopulateColumns="True"><dxmvvm:Interaction.Behaviors><local:GridLayoutHelperLayoutChanged="OnGridLayoutChanged"/></dxmvvm:Interaction.Behaviors></dxg:GridControl>

To learn more on how to implement similar functionality in Silverlight, refer to the T243422 example.

[C#]
columnwidthchangehandlerdoesn'twork.Imeannoneofpropertydescriptorwork.Ihadtochangebelowcodebyaddingcolumnscountcheck(&&Grid.Columns.Count> 0)butstillnoluck.if(Grid.Columns!=null){SubscribeColumns();}

[C#]
DependencyPropertyDescriptor.FromProperty(GridColumn.ActualWidthProperty,typeof(GridColumn)).AddValueChanged(column,OnColumnWidthChanged);DependencyPropertyDescriptor.FromProperty(GridColumn.VisibleIndexProperty,typeof(GridColumn)).AddValueChanged(column,OnColumnVisibleIndexChanged);DependencyPropertyDescriptor.FromProperty(GridColumn.GroupIndexProperty,typeof(GridColumn)).AddValueChanged(column,OnColumnGroupIndexChanged);DependencyPropertyDescriptor.FromProperty(GridColumn.VisibleProperty,typeof(GridColumn)).AddValueChanged(column,OnColumnVisibleChanged);

UPDATED:

Starting from the 18.2 version of our controls, we support this scenario out of the box. Please review the Date and Time: Month-Year Picker demo.


This example demonstrates how to create a DateEdit counterpart based on ASPxDropDownEdit with a custom DropDownWindowTemplate, that will allow you to select Year and Month only.

This example demonstrates how to implement BootstrapGridView context menu with items similar to ASPxGridView. These items include CRUD operations to Insert, Update, Delete data in BootstrapGridView's data source, operations to enable or disable FilterRow, SearchPanel and GroupPanel, and operations to change Visible property of BootstrapGridView's columns.

The Javascript dictionary object is used to save BootstrapGridView's elements visibility states on client side.

In page markup, handle the BootstrapClientGridView.Init event and add event handler for contextmenu event of BootstrapGridView's main element. This event handler is used to set the Enabled and Text properties of BootstrapPopupMenu items depending on BootstrapGridView's elements visibility and clicked item index. To get the clicked item index, perform the following steps:
1) Call ASPxClientUtils.GetEventSource method to obtain the object that fired the current event.
2) Convert the object to jQuery object.
3) In page markup, set the CssClasses.Row property to the "grid-row" and pass that parameter to the parents method of the jQuery object to get GridView row javascript object.
4) Use the GetPageIndex method and a private BootstrapClientGridView's pageRowSize field of with applied to the jQuery GridView row object index method.
To receive the clicked BootstrapGridView item's ID on the client side, use BootstrapClientGridView.GetRowKey method.

Then handle the BootstrapGridView's CustomCallback event to add the current BootstrapGridView's elements visibility states to its JSProperties, and to transfer them from the server to the client. Handle BootstrapClientGridView.EndCallback event to get access to its JSProperties and to write updated BootstrapGridView's elements visibility states to the javasript dictionary.

Handle the BootstrapClientPopupMenu.ItemClick event to perform an action depending on the selected item. Use the ASPxClientMenuItem.name property to determine the selected item name and switch the applied action.
To manipulate BootstrapGridView data on the client side use AddNewRow, StartEditRow and DeleteRowBootstrapClientGridView's methods.
To change BootstrapGridView's elements visibility states, call the BootstrapClientGridView.PerformCallback method.

To open a detail view for the currently selected object LookupPropertyEditor, you can press Ctrl+Shift while clicking the editor.
Another way is to implement your LookupPropertyEditor's descendant, which will provide the specific functionality you need.
LookupPropertyEditor is represented in a detail view by the LookUpEdit control, which allows various customizations. You can customize it by adding a special button that invokes a detail view for the selected object or performs any other actions.



See Also:

How to work with referenced properties via a simple drop down list instead of the standard LookupPropertyEditor (Example)

The PivotGrid allows sorting by any column. To do this, right click any field value and select an appropriate field to sort by it. Sometimes it is possible to sort by any column by simply clicking on it. This example shows how to implement this behavior. 

This example illustrates one of the possible approaches to implementing an identifier field with sequential values. Alternate approaches are listed in the An overview of approaches to implementing a user-friendly sequential number for use with an XPO business class KB article.

Scenario
This is a variation of the How to generate and assign a sequential number for a business object within a database transaction, while being a part of a successful saving process XPO example, which was specially adapted for XAF applications.

In particular, for better reusability and more smooth integration with the standard XAF CRUD Controllers, all the required operations to generate sequences are managed within the base persistent class automatically when a persistent object is being saved. For more developer convenience, this solution is organized as a reusable XAF module - GenerateUserFriendlyId.Module. This module consists of several key parts:

    - Sequence and SequenceGenerator are auxiliary classes that take the main part in generating user-friendly identifiers. Take special note that the SequenceGenerator.Initialize method must be called during your XAF application startup for the correct operation.

    - UserFriendlyIdPersistentObject is a base persistent class that subscribes to XPO's Session events and delegates calls to the core classes above. Normally, you must inherit your own business classes from this base class to get the described functionality in your project.

    - IUserFriendlyIdDomainComponent is a base domain component that should be implemented by all domain components that require the described functionality.

Check the original example description first for more information on the demonstrated scenarios and functionality.

Steps to implement
1. Copy and include the GenerateUserFriendlyId.Module project into your solution and make sure it is built successfully.  Invoke the Module or Application Designer for the YourSolutionName.Module/Module.xx  or YourSolutionName.Wxx/WxxApplication.xx files by double-clicking it in Solution Explorer. Invoke the Toolbox (Alt+X+T) and then drag & drop the GenerateUserFriendlyIdModule component into the modules list on the left.

2. For apps with no security or with the Client-Side Security (XPObjectSpaceProvider or SecuredObjectSpaceProvider):
In the YourSolutionName.Wxx/WxxApplication.xx files, modify the CreateDefaultObjectSpaceProvider method to call the SequenceGenerator.Initialize method as shown in the Demo.Wxx\WxxApplication.xx files:

[C#]
protectedoverridevoidCreateDefaultObjectSpaceProvider(CreateCustomObjectSpaceProviderEventArgsargs){IXpoDataStoreProviderdataStoreProvider=XPObjectSpaceProvider.GetDataStoreProvider(args.ConnectionString,args.Connection,true);// Web:// IXpoDataStoreProvider dataStoreProvider = GetDataStoreProvider(args.ConnectionString, args.Connection);GenerateUserFriendlyId.Module.SequenceGenerator.Initialize(dataStoreProvider);...}

For apps with the Middle Tier Security (DataServerObjectSpaceProvider):
In the YourSolutionName.ApplicationServer project, locate and modify the serverApplication_CreateCustomObjectSpaceProvider or CreateDefaultObjectSpaceProvider  methods to call the SequenceGenerator.Initialize method in the same manner.

3. If you are using pure XPO classes, then inherit your business classes to which you want to add sequential numbers from the module's UserFriendlyIdPersistentObject class. Declare a calculated property that uses the SequenceNumber property of the base class to produce an string identifier according to the required format:

[C#]
publicclassContact:GenerateUserFriendlyId.Module.BusinessObjects.UserFriendlyIdPersistentObject{[PersistentAlias("Concat('C',PadLeft(ToStr(SequentialNumber),6,'0'))")]publicstringContactId{get{returnConvert.ToString(EvaluateAlias("ContactId"));}}

If you are using DC interfaces, then implement the IUserFriendlyIdDomainComponent interface by your custom domain component:

[C#]
publicinterfaceIDocument:GenerateUserFriendlyId.Module.BusinessObjects.IUserFriendlyIdDomainComponent{[Calculated("Concat('D',PadLeft(ToStr(SequentialNumber),6,'0'))")]stringDocumentId{get;}

Additionally for DC, use the UserFriendlyIdPersistentObject as a base class during your custom domain component registration, e.g.:

[C#]
XafTypesInfo.Instance.RegisterEntity("Document",typeof(IDocument),typeof(GenerateUserFriendlyId.Module.BusinessObjects.UserFriendlyIdPersistentObject));

Note that the sequential number functionality shown in this example does not work with DC shared parts , because it requires a custom base class, which is not allowed for shared parts.

4. By default, separate sequences are generated for each busienss object type. If you need to create multiple sequences for the same type, based on values of other object properties, override the GetSequenceName method and return the costructed sequence name. The Address class in this example uses separate sequences for each Province as follows:

[C#]
protectedoverridestringGetSequenceName(){returnstring.Concat(ClassInfo.FullName,"-",Province.Replace(" ","_"));}

5. For more information, download and review the Address, Contact, and IDocument types within the Demo.Module project. These are test business objects that demonstrate the use of the described functionality for XPO and DC respectively. Feel free to modify this example to add functionality as your business needs dictate.

IMPORTANT NOTES

1. As an alternative, you can implement much simpler solutions at the database level or by using the built-in DistributedIdGeneratorHelper.Generate method. Refer to the An overview of approaches to implementing a user-friendly sequential number for use with an XPO business class article for more details.

2.  In the Integrated Mode and middle-tier Application Server scenario the newly generated sequence number will appear in the DetailView only after a manual refresh (i.e., it will be empty right away after saving a new record), because the sequence is generated on the server side only and is not passed to the client. You can download a ready test project for these configurations here. See also the "Refresh the Identifier field value in UI" section in this KB article.
3. You can specify or seed the initial sequence value manually: either by editing the Sequence table in the database or using the standard XPO/XAF means by manipulating the Sequence objects, e.g.:

[C#]
using(IObjectSpaceos=Application.CreateObjectSpace(typeof(Sequence))){Sequencesequence=os.FindObject<Sequence>(CriteriaOperator.Parse("TypeName=?",typeof(E2829).FullName));sequence.NextSequence= 5;os.CommitChanges();}

Your feedback is needed!
We would greatly appreciate it if you share your feedback here in comments or rather participate in this short survey (~3 min).

Starting with v17.1.4 and v17.2.3, the BootstrapGridView control supports this functionality out of the box. To get the desired behavior, enable the AlwaysShowCheckboxesInCheckColumns property:

[ASPx]
<SettingsEditing><BatchEditSettingsAlwaysShowCheckboxesInCheckColumns="true"/></SettingsEditing>

 The approach demonstrated in the example is OBSOLETE. It should be used with old versions only.

In old versions, BootstrapGridView displayed cells in CheckBox columns as images which makes it impossible to edit these cells in a single click. First, you have to click the cell to enter the edit mode and the second click actually changes the value. It is not very convenient, so we created a workaround that allows editing such columns in a single click.

For this, define a data item template for the CheckBox column and place an actual check box there. Synchronize this check box with the item collection - obtain the value using the Eval (or Bind) method and set a new value with SetCellValue.

By default, RichEditControl can import HTML files containing embedded images or links to external images with the src attribute specified as an image URL. Occasionally, you may have a web file where images are referenced in a custom manner (e.g. using the prefix 'cid' in the img src attribute, as in email files). In this scenario, you should implement and register a custom IUriStreamProvider to import these files into a RichEditControl correctly. This example illustrates the technique used to get an image referenced with the "cid" prefix from an external file in "bmp" format.

See Also:
Building a mail application with the RichEditControl

RicheditControlName.Options.Import.Html.AsyncImageLoading = false;

[C#]
// HTMLImport (https://www.devexpress.com/Support/Center/Example/Details/E3123)privateclassCustomUriStreamProvider:IUriStreamProvider{privatestringbasePath;//private string imageExtension;publicstringBasePath{get{returnbasePath;}set{basePath=value;}}publicCustomUriStreamProvider(stringbasePath){BasePath=basePath;}privatestaticSystem.Drawing.Imaging.ImageFormatGetImageFormat(System.Drawing.Imageimg){if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Jpeg))returnSystem.Drawing.Imaging.ImageFormat.Jpeg;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Bmp))returnSystem.Drawing.Imaging.ImageFormat.Bmp;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Png))returnSystem.Drawing.Imaging.ImageFormat.Png;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Emf))returnSystem.Drawing.Imaging.ImageFormat.Emf;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Exif))returnSystem.Drawing.Imaging.ImageFormat.Exif;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Gif))returnSystem.Drawing.Imaging.ImageFormat.Gif;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Icon))returnSystem.Drawing.Imaging.ImageFormat.Icon;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.MemoryBmp))returnSystem.Drawing.Imaging.ImageFormat.MemoryBmp;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Tiff))returnSystem.Drawing.Imaging.ImageFormat.Tiff;else{System.Diagnostics.Debug.Print("Cannot find type use it as a WMF image");returnSystem.Drawing.Imaging.ImageFormat.Wmf;}}publicStreamGetStream(stringurl){//string fileName = string.Format("{0}", url.Replace("cid:", string.Empty));stringfileName=string.Format("{0}",url.Replace("cid:",string.Empty));try{if(File.Exists(BasePath+fileName)){MemoryStreammemoryStream=newMemoryStream();Imageimage=Image.FromFile(BasePath+fileName);System.Diagnostics.Debug.Print("Loading Image: "+BasePath+fileName);image.Save(memoryStream,GetImageFormat(image));memoryStream.Seek(0,SeekOrigin.Begin);returnmemoryStream;}else{thrownewFileNotFoundException(@"File "+BasePath+fileName+" is not found");}}catch(Exceptionex){XtraMessageBox.Show("Error loading image "+BasePath+fileName+" from html template possible corrupt file?\r\n\r\n"+ex);returnnull;}}}// ExportprivateclassRichEditMailMessageExporter:IUriProvider{readonlyRichEditControlcontrol;readonlyOutlook._MailItemmailItem;intimageId;stringtempFiles=Path.Combine(Directory.GetCurrentDirectory(),"TempFiles");publicRichEditMailMessageExporter(RichEditControlcontrol,Outlook._MailItemmailItem){Guard.ArgumentNotNull(control,"control");Guard.ArgumentNotNull(mailItem,"mailItem");this.control=control;this.mailItem=mailItem;}publicvirtualvoidExport(){if(!Directory.Exists(tempFiles))Directory.CreateDirectory(tempFiles);control.BeforeExport+=OnBeforeExport;stringhtmlBody=control.Document.GetHtmlText(control.Document.Range,this);control.BeforeExport-=OnBeforeExport;mailItem.BodyFormat=Outlook.OlBodyFormat.olFormatHTML;mailItem.HTMLBody=htmlBody;}privatevoidOnBeforeExport(objectsender,BeforeExportEventArgse){HtmlDocumentExporterOptionsoptions=e.OptionsasHtmlDocumentExporterOptions;if(options!=null){options.Encoding=Encoding.UTF8;}}#regionIUriProviderMemberspublicstringCreateCssUri(stringrootUri,stringstyleText,stringrelativeUri){returnString.Empty;}publicstringCreateImageUri(stringrootUri,OfficeImageimage,stringrelativeUri){stringimageName=String.Format("image{0}.png",imageId);imageId++;stringimagePath=Path.Combine(tempFiles,imageName);image.NativeImage.Save(imagePath,ImageFormat.Png);mailItem.Attachments.Add(imagePath,Outlook.OlAttachmentType.olByValue, 0,Type.Missing);return""+imageName;//using cid: breaks images in my webmail (squirrelmail)}#endregion}

[C#]
// Custom IUriStreamProvider registrationIUriStreamServiceuriStreamService=rBox.GetService<IUriStreamService>();varHTMLimport=newCustomUriStreamProvider(imagePath);uriStreamService.RegisterProvider(HTMLimport);rBox.Options.Import.Html.AsyncImageLoading=false;rBox.HtmlText=html;if(HTMLimport.HasErrorMessage!=string.Empty){thrownewSystem.Exception(HTMLimport.HasErrorMessage);}uriStreamService.UnregisterProvider(HTMLimport);SetDefaultFont(rBox);

[C#]
// HTMLImport (https://www.devexpress.com/Support/Center/Example/Details/E3123)#regionHTMLImportClassprivateclassCustomUriStreamProvider:IUriStreamProvider{privatestringbasePath;//private string imageExtension;publicstringBasePath{get{returnbasePath;}set{basePath=value;}}publicstringHasErrorMessage{get;privateset;}publicCustomUriStreamProvider(stringbasePath){HasErrorMessage=string.Empty;BasePath=basePath;}privatestaticSystem.Drawing.Imaging.ImageFormatGetImageFormat(System.Drawing.Imageimg){if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Jpeg))returnSystem.Drawing.Imaging.ImageFormat.Jpeg;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Bmp))returnSystem.Drawing.Imaging.ImageFormat.Bmp;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Png))returnSystem.Drawing.Imaging.ImageFormat.Png;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Emf))returnSystem.Drawing.Imaging.ImageFormat.Emf;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Exif))returnSystem.Drawing.Imaging.ImageFormat.Exif;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Gif))returnSystem.Drawing.Imaging.ImageFormat.Gif;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Icon))returnSystem.Drawing.Imaging.ImageFormat.Icon;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.MemoryBmp))returnSystem.Drawing.Imaging.ImageFormat.MemoryBmp;if(img.RawFormat.Equals(System.Drawing.Imaging.ImageFormat.Tiff))returnSystem.Drawing.Imaging.ImageFormat.Tiff;else{System.Diagnostics.Debug.Print("Cannot find type use it as a WMF image");returnSystem.Drawing.Imaging.ImageFormat.Wmf;}}publicStreamGetStream(stringurl){stringfileName=string.Format("{0}",url.Replace("cid:",string.Empty));try{if(File.Exists(BasePath+fileName)){MemoryStreammemoryStream=newMemoryStream();Imageimage=Image.FromFile(BasePath+fileName);System.Diagnostics.Debug.Print("Loading Image: "+BasePath+fileName);image.Save(memoryStream,GetImageFormat(image));memoryStream.Seek(0,SeekOrigin.Begin);returnmemoryStream;}else{thrownewFileNotFoundException(@"File "+BasePath+fileName+" is not found");}}catch(Exceptionex){this.HasErrorMessage="Error loading image "+BasePath+fileName+" from html template possible corrupt file?\r\n\r\n"+ex;returnnull;}}}#endregion// Export#regionEmbeddedimageExportprivateclassRichEditMailMessageExporter:IUriProvider{readonlyRichEditControlcontrol;readonlyOutlook._MailItemmailItem;intimageId;stringtempFiles=Path.Combine(Directory.GetCurrentDirectory(),"TempFiles");publicRichEditMailMessageExporter(RichEditControlcontrol,Outlook._MailItemmailItem){Guard.ArgumentNotNull(control,"control");Guard.ArgumentNotNull(mailItem,"mailItem");this.control=control;this.mailItem=mailItem;}publicvirtualvoidExport(){if(!Directory.Exists(tempFiles))Directory.CreateDirectory(tempFiles);control.BeforeExport+=OnBeforeExport;stringhtmlBody=control.Document.GetHtmlText(control.Document.Range,this);control.BeforeExport-=OnBeforeExport;mailItem.BodyFormat=Outlook.OlBodyFormat.olFormatHTML;mailItem.HTMLBody=htmlBody;}privatevoidOnBeforeExport(objectsender,BeforeExportEventArgse){HtmlDocumentExporterOptionsoptions=e.OptionsasHtmlDocumentExporterOptions;if(options!=null){options.Encoding=Encoding.UTF8;}}#regionIUriProviderMemberspublicstringCreateCssUri(stringrootUri,stringstyleText,stringrelativeUri){returnString.Empty;}publicstringCreateImageUri(stringrootUri,OfficeImageimage,stringrelativeUri){stringimageName=String.Format("image{0}.png",imageId);imageId++;stringimagePath=Path.Combine(tempFiles,imageName);image.NativeImage.Save(imagePath,ImageFormat.Png);mailItem.Attachments.Add(imagePath,Outlook.OlAttachmentType.olByValue, 0,Type.Missing);return""+imageName;//using cid: breaks images in my webmail (squirrelmail)}#endregion}#endregion

==============================
This article is now obsolete. Instead, refer to the eXpressApp Framework> Concepts> UI Construction> Using a Custom Control that is not Integrated by Default overview article and the following two help topics in particular:
    eXpressApp Framework> Task-Based Help> How to: Show a Custom Data-Bound Control in an XAF View (WinForms)
    eXpressApp Framework > Task-Based Help > How to: Show a Custom Data-Bound Control in an XAF View (ASP.NET)
    Concepts  > UI Construction  > Views  > Ways to Show a View
    How to: Show a Custom Windows Form
    How to: Show a Custom Window with an Embedded XAF View
    Ways to Show a Confirmation Dialog 
==============================
This example implements the following scenarios when an end-user clicks on a custom item in the navigation control:

- a custom non-XAF form is opened as a result;

- a standard XAF View containing a custom user control is opened as a result.

Both custom forms and user controls display persistent data from the XAF application database. For that purpose, this example solution provides a set of reusable elements (custom ViewItem and Application Model extensions) organized in a way that you can once implement them in an XAF module and reuse to display custom user controls in various forms.

IMPORTANT NOTES
If you do not require a complex and reusable solution for this task, it is recommended to use a much simpler and built-in XAF solution - ControlDetailItem placed within a DashboardView. This item can be added and customized as described at eXpressApp Framework > Task-Based Help > How to: Create a Custom Control Detail Item. See also the Using a Control that is not Integrated by Default article for other integration options.

If this is NOT your case, proceed to the instructions below.

STEPS TO IMPLEMENT

1. Define a base structure of the navigation control in your XAF application, as shown in the E911.Module\Model.DesignedDiffs.xafml file.

You can simply copy and paste the contents of the NavigationItems element into the corresponding file (pre-opened via the text editor) of your platform-agnostic module.

The same customizations can be achieved via the Model Editor visually.
Take special note that you can set the View parameter to any View from the list, e.g. AboutInfo_DetailView, BaseObject_ListView, etc.

This navigation structure will be further customized in the WinForms and ASP.NET executable projects later.

2. Intercept events of the navigation control to display a custom form when a custom navigation item is clicked.

To do this, implement a WindowController into your platform-agnostic module and handle events of the ShowNavigationItemController class as per the E911.Module\Controllers\ShowCustomFormWindowController.xx file. This controller will be abstract and be overridden in WinForms and ASP.NET modules.

3. Declare a custom ViewItem class that is supposed to host a custom user control in the standard XAF View. To do this, implement a custom ViewItem descendant and related types in the platform-agnostic module as shown in the E911.Module\Editors\CustomUserControlViewItem.xx file.

This ViewItem will also be abstract and platform-agnostic as it will not create platform-dependent controls, and will just provide a common customization code for both platforms. For instance, the OnControlCreated method will be overridden to bind the created control to data. To access persistent data from the database used by an XAF application, the ViewItem will implement the IComplexViewItem interface that consists of a single Setup method, receiving the IObjectSpace and XafApplication objects as parameters.

To unify our data binding code for both platforms, the IXpoSessionAwareControl interface and an auxiliary XpoSessionAwareControlInitializer class are introduced.

The interface provides a single UpdateDataSource method that is implemented by custom forms and user controls to bind them to data received by means of XPO.

You can use a similar mechanism and modify these auxiliary types to pass other custom data into your custom forms and controls.

4. Define a base structure of the standard XAF View with a custom ViewItem as shown in the E911.Module\Model.DesignedDiffs.xafml file.

You can simply copy and paste the contents of the Views element into the corresponding file (pre-opened via the text editor) of your platform-agnostic module.

5. Create custom forms and user controls in WinForms and ASP.NET executable projects analogous with what is shown in the example. The easiest way to do this is to copy the contents of the E911.Win\Controls and E911.Web\Controls folders and then include the necessary files into your solution. Take special note that these custom forms and controls implement the IXpoSessionAwareControl interface to automatically receive persistent data and other parameters when they are created.

6. Implement platform-dependent behavior to open and customize custom forms and controls. To do this, copy the following files into your WinForms and ASP.NET module projects:

WinForms:

E911.Module.Win\Controllers\WinShowCustomFormWindowController.xx - contains an WinForms version of the WindowController, which is inherited from the platform-agnostic

E911.Module.Win\Editors\WinCustomUserControlViewItem.xx - contains an WinForms version of the ViewItem, which is inherited from the platform-agnostic one;

E911.Module.Win\WinModuleEx.xx - contains a registration code for WinForms version of the ViewItem;

ASP.NET:

E911.Module.Web\Editors\WebCustomUserControlViewItem.xx - contains an ASP.NET version of the ViewItem, which is inherited from the platform-agnostic one;

E911.Module.Web\WebModuleEx.xx - contains a registration code for ASP.NET version of the ViewItem;

E911.Module.Web\Controllers\WebShowCustomFormWindowController.xx - contains an ASP.NET version of the WindowController, which is inherited from the platform-agnostic one;

These platform-dependent versions of the WindowController and ViewItem are required to implement the creation and display of custom forms and controls using the means specific for each platform. They are also designed to provide the capability to be able to set custom forms and control settings via the Model Editor. For that purpose, custom Application Model extensions are implemented for the Navigation Item and View Item model elements.

7. Set the custom forms and controls settings for each platform.

To do this, copy the contents of the E911.Win\Model.xafml and E911.Web\Model.xafml files into the Model.xafml file in the executable WinForms and ASP.NET projects:

WinForms:

ASP.NET:

OTHER IMPLEMENTATION CONSIDERATIONS

1. It is also possible to mix the traditional and XAF development approaches (consult our Support Team if you are not sure how to integrate your standard non-XAF solution into XAF), because an XAF application is a regular .NET application built of reusable blocks like View, ViewItem, Property and List Editors, etc. that eventually create and customize platform-dependent controls exactly the same way you do this without XAF. So, using XAF does not mean something absolutely new and allows you to reuse your existing development skills and practices. Of course, it is possible to create your own reusable blocks if the standard ones do not meet your needs. For instance, the example of a custom View class designed to show a custom form can be found on CodeProject here.

2. This solution contains some generic code (e.g., base WindowController and ViewItem) that is mainly required because our XAF application is for both Windows and the Web. You may avoid this generic code and make a simpler implementation if you are developing for only one platform.

3. You can display custom forms not only when interacting with the navigation control, but from any other place. To do this, intercept the events of a required entity, e.g., an XAF Controller, Action or a View. Refer to the product documentation or consult with our Support Team in case of any difficulties.

4. By default controls layout and user customizations are preserved only for built-in XAF ListEditors, because they have special code for that. If you embed a custom user control into XAF, you need to preserve its settings yourself as well, exactly like you would do when implementing this task in the "old way" in a non-XAF application. Refer to the control's documentation to learn more on how to accomplish this task.

Feel free to contact the respective product team if you experience any difficulties customizing this control.

See also:
How to create controls dynamically
How much of XAF's default UI is customizable.
How to Show a Window via an Action
How to: Display a List of Non-Persistent Objects
How to: Display a Non-Persistent Object's Detail View from the Navigation
ShowNavigationItemController.CustomShowNavigationItem Event
XafApplication.CustomProcessShortcut Event

Suppose we have the same classes structure as shown in the How to: Use UpCasting help topic.
Our goal is to provide two details collections into a DetailView that will allow end-users to view objects of the LocalEmployee and ForeignEmployee classes separately in a Department DetailView.
In order to do this, we will declare two calculated details collections in the Department class and also write some code to update these collections when objects are added in or deleted from the main (associated) Employees collections.
By design the Employees collection is intended to list both local and foreign employees and also to allow end-users to perform any operations with them. The LocalEmployees and ForeignEmployees collections are intended to view objects only. So, the corresponding nested ListViews will be readonly.

See Also:
How to: Set Relationships Between Objects
How to: Calculate a Property Value Based on Values from a Detail Collection
How to filter persistent objects against their type
Collection properties and the New/Delete/Link/Unlink Actions

Scenario

For certain data forms, a developer needs to limit end-users to editing only through the ListView, i.e. without invoking a separate DetailView.  This is usually done by activating the inline editing and MasterDetailMode = ListViewAndDetailView features as described at eXpressApp Framework > Concepts > UI Construction > Views > List View Edit Modes. More real user scenarios are described in this Support Center thread.

For more convenience and flexibility, the following Model Editor extensions are implemented in the example to control this behavior:
 - The DefaultShowDetailViewFromListView  property at the Views node level allows you to control this functionality globally per application via the Model Editor;
 - The ShowDetailView property at the Views | ListView node level allows you to customize only certain List Views via the Model Editor;




Steps to implement

1. Copy the WinWebSolution.Module\ShowDetailViewFromListViewController.xx file into the YourSolutionName.Module project and rebuild it.

The process of opening a DetailView by double clicking/pressing the Enter key on a record selected in a ListView is managed by the standard DevExpress.ExpressApp.SystemModule.ListViewProcessCurrentObjectController class and its ProcessCurrentObjectAction (we can disable this Action to accomplish our task). For more information, refer to the following help topics:
    Concepts > Application Model > Extend and Customize the Application Model in Code
    eXpressApp Framework > Concepts > Application Model > Access the Application Model in Code
    ActionBase.Enabled Property

2. For testing purposes, invoke the Model Editor and set the DefaultShowDetailViewFromListView or ShowDetailView properties for the Views or Views | YourObjetType_ListView nodes to False and run the test app to see that a required ListView no longer opens a DetailView in the aforementioned scenario.

Note
We added some optimizations intended to improve the DetailView opening performance. This optimization depends on the default behavior - the ListView item click opens a DetailView. We suggest that you disable this optimization if you suppress DetailView opening to avoid issues. To disable the optimization, add the following code to the App_Start event handler:

DevExpress.ExpressApp.Web.WebApplication.OptimizationSettings.AllowFastProcessListViewRecordActions = false;

IMPORTANT NOTES
This article covers only the case when a DetailView is shown from the ListView after a User double clicks/presses the enter key on a record. Other scenarios should be handled separately by extending the code of this controller. For example, if you do not want to show a DetailView after a new object is created via the New Action, you can handle the NewObjectViewController.ObjectCreating event and set its ObjectCreatingEventArgs.ShowDetailView property to False. However, this is outside the purpose of this article.

============================================================
This example is now obsolete. Refer to the How to: Raise XAF Callbacks from Client-Side Events and Process these Callbacks on Server topic for more details.
============================================================

Scenario:

It is necessary to execute server-side code that requires refreshing the current View as a response to user actions in an ASP.NET application. For example, show the first navigation item when a new navigation group is selected.

Steps to Implement:

1. Create a Controller that implements the IXafCallbackHandler interface. This interface allows defining server-side code that is executed when an XAF callback is raised.
2. Place the required server-side code to the IXafCallbackHandler.ProcessAction method, e.g. change ShowNavigationItemAction's selected item.
3. Subscribe to the Window.ProcessActionContainer event to access a navigation control (NavigationTabsActionContainer).
4. Raise an XAF callback by passing javascript generated by the XafCallbackManager.GetScript method to the NavigationTabsActionContainer.PageControl.ClientSideEvents.ActiveTabChanged event handler.
5. Register your callback handler (Controller) using the XafCallbackManager.RegisterHandler method.

See also:
How to implement the drill-down functionality in Web PivotGrid (ASPxPivotGrid)
How to automatically refresh data in a View after a certain period of time on the Web
Task-Based Help > How to: Open a Detail View When the Grid Row is Clicked in the Dashboard

Update: Approaches from this example are now described in the How to: Access Master Detail View and Nested List View Environment topic. Refer to it for a more detailed description.

This example is based on the following facts:

1. The nested ListView is shown in the parent DetailView via the ListPropertyEditor. The ListPropertyEditor class has the Frame property that returns the nested frame and the ListView property that returns the nested ListView. To get the ListPropertyEditor, use the DetailView.FindItem or DetailView.GetItems method.

2. The nested list view's frame is represented by the NestedFrame class that has the ViewItem property, which returns the ListPropertyEditor from the parent DetailView. It is possible to access the parent DetailView via the ListPropertyEditor's View property.

Note that this code is required only if you need to access views and frames. If you need to access child business objects from the parent DetailView, simply get the DetailView's CurrentObject, cast it to the corresponding type and use its collection property. If you need to access the parent object from the nested ListView, use the PropertyCollectionSource.MasterObject property, as shown in the How to: Access the Master Object from a Nested List View help topic.

How to use a custom Lookup Property Editor control for reference properties in WinForms

FEATURES

LookupPropertyEditorEx This is a regular XAF PropertyEditor class that can be used for referenced properties instead of the standard LookupPropertyEditor in Windows Forms applications. By default, this editor allows you to choose a value from the drop down list. It's possible to find the required record in the drop down list by typing text (auto-incremental search). If you want to clear a value, use either the Control+Delete keystroke or click the minus (-) button. If you want to add a new object, click the plus (+) button. It will show a modal DetailView allowing you to fill object properties and save it.

IMPORTANT NOTES

From this example, you need use only one assembly (the WinSolution from the example is just a demo application, and it has no relation to the solution): Editors.Win.dll Since this is a regular XAF module, you should add this module to your application to be able to use its features. In case of standard modules, you add them from the Toolbox via the Application or Module designer. Since we deal with a custom module, you should add this into the Toolbox manually. Please refer to the How to: Add Items to the Toolbox article in MSDN, for more details. Alternatively, you can take the source code and include it in your solution.

The LookupPropertyEditorEx is set as default for all lookup properties in the application. If you want to change this, then invoke the Model Editor for the Windows Forms application project or module, and change the EditorType property of the DetailViewItems | PropertyEditors | LookupProperty node. Or, change the PropertyEditorType property for a class member, ListView column or DetailView item nodes individually.

See Also:

Implement Custom Property Editors 
PropertyEditors.Lookup - How to provide alternative data representations for reference lookup properties (e.g., a simple drop-down box, a complex multi-column grid, or a tree view)