This example is the third part of the SpreadsheetControl API set of examples that demonstrates how to use the SpreadsheetControl API to programmatically manage spreadsheet documents, without the need for Microsoft Excel to be installed.

This sample introduces API properties and methods used to perform the following operations:

- Apply data validation to control the type of data or the values that users enter into a cell

Starting from v2016 vol.2:
- Remove rows and columns that meet the specified condition
- Custom XML Parts examples

See also:
WinForms SpreadsheetControl API
WinForms SpreadsheetControl API - Part 2

Files to look at:

This example is the second part of the SpreadsheetControl API set of examples that demonstrates how to use the SpreadsheetControl API to programmatically manage spreadsheet documents, without the need for Microsoft Excel to be installed.

This sample introduces API properties and methods used to perform the following operations:

- Insert, delete and modify pictures
- Add a hyperlink to a picture
- Add custom functions to the spreadsheet

Starting from v2013 vol.2:
- Create a table
- Apply a custom style to the table

Starting from v2014 vol.1:
- Protect a workbook
- Protect a worksheet
- Apply user-specific permissions to a range in a protected worksheet
- Sort a range in descending and ascending orders
- Sort using a custom comparer
- Sort by multiple columns
- Simple search
- Search with options
- Export to HTML

Starting from v2014 vol.2:
- Group and outline data
- Insert subtotals
- Filter the data by a list of values
- Apply a number filter
- Apply a text filter
- Apply a dynamic filter
- Sort the filtered data
- Specify the built-in document properties
- Specify the custom document properties

See also:
WinForms SpreadsheetControl API
WinForms SpreadsheetControl API - Part 3

Files to look at:

This example demonstrates how to use the Spreadsheet Document API to programmatically manage spreadsheet documents, without the need for Microsoft Excel to be installed.
The application includes the RichEditControl  used to display and edit the code. The code modifies the spreadsheet document loaded in the Workbook instance. To see the results, open the document in Microsoft Excel by clicking the button.
You can modify the code and watch the result. If an error occurs during compilation or execution, the backcolor of the code window changes.

This sample introduces API properties and methods used to perform the following operations:

- Insert, delete and modify pictures
- Add a hyperlink to a picture
- Create a table
- Apply a custom style to the table
- Protect a workbook
- Protect a worksheet
- Apply user-specific permissions to a range in a protected worksheet
- Sort a range in descending and ascending orders
- Sort by multiple columns
- Simple search
- Search with options
- Export to HTML
- Group and outline data
- Insert subtotals
- Filter data by a list of values
- Apply a number filter
- Apply a text filter
- Apply a dynamic filter
- Sort the filtered data

For more information, review the Examples section in the documentation.

The Universal Subscription or an additional Office File API Subscription is required to use this example in production code. Please refer to the DevExpress Subscription page for pricing information.

See also:

Spreadsheet Document API - Part 1

Spreadsheet Document API - Part 3

Files to look at:

This example demonstrates how to use the Spreadsheet Document API to programmatically manage charts in worksheets.
The application includes the RichEditControl used to display and edit the code. The code modifies the spreadsheet document loaded into the Workbook instance. To see the results, open the document in Microsoft Excel by clicking the button.
You can modify the code and watch the result. If an error occurs during compilation or execution, the backcolor of the code window changes.

Starting from v2015 vol.1:
- Insert and modify sparklines

The Universal Subscription or an additional Office File API Subscription is required to use this example in production code. Please refer to the DevExpress Subscription page for pricing information.

Files to look at:

This example is obsolete. Starting with version 16.2.12, our RichEditControl supports horizontal auto-scrolling in disabled word wrap mode out of the box. Please refer to the The horizontal scrollbar incorrectly operates in SimpleView when the SimpleView.WordWrap property is disabled thread for more information.

At present, the Simple view does not support auto-scrolling. As a workaround, switch RichEditControl to the Draft view and specify a large width for it via the SectionPage.Width Property. To emulate the Simple view, hide the ruler and scrollbar by setting the RichEditControl.Options.HorizontalRuler.Visibility and RichEditControl.Options.VerticalScrollbar.Visibility properties to the Hidden value. In addition, you can adjust document content padding in the manner illustrated in the How to adjust left padding of a document in RichEditControl example.

Files to look at:

This example describes how to implement an OData4 service with XPO. This example is an ASP.NET Core 2.2 MVC Web API project and provides simple REST API for data access.

Steps to implement:

"ConnectionStrings": {"MSSqlServer": "XpoProvider=MSSqlServer;data source=(LocalDB)\\MSSQLLocalDB;Integrated Security=true;MultipleActiveResultSets=true;initial catalog=ODataTest"
  }

[C#]
publicvoidConfigureServices(IServiceCollectionservices){services.AddOData();services.AddODataQueryFilter();services.AddMvc(options=>{options.EnableEndpointRouting=false;}).SetCompatibilityVersion(CompatibilityVersion.Version_2_2);services.AddXpoDefaultUnitOfWork(true,(DataLayerOptionsBuilderoptions)=>options.UseConnectionString(Configuration.GetConnectionString("MSSqlServer")).UseAutoCreationOption(AutoCreateOption.DatabaseAndSchema)// debug only.UseEntityTypes(ConnectionHelper.GetPersistentTypes()));}

[C#]
publicvoidConfigure(IApplicationBuilderapp,IHostingEnvironmentenv){if(env.IsDevelopment()){app.UseDeveloperExceptionPage();}else{// The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.app.UseHsts();}//app.UseHttpsRedirection();app.UseODataBatching();app.UseMvc(b=>{b.Count().Filter().OrderBy().Expand().Select().MaxTop(null);b.MapODataServiceRoute("odata","odata",SingletonEdmModel.GetEdmModel(),newDefaultODataBatchHandler());});}

This example demonstrates how to create new JSON connections in Web Dashboard's Data Source wizard and store them in a database.

Set the ASPxDashboard.CanCreateNewJsonDataSource property to True to allow creating new JSON connections. Implement the IDataSourceWizardConnectionStringsStorage interface to create custom connection string storage, and use the ASPxDashboard or DashboardConfigurator's SetConnectionStringsProvider method to assign it to the Web Dashboard.

In this example, connections are stored in a database using Entity Framework. To run the example, modify the "ConnectionStorage" connection string in Web.config.

Files to look at:

This example demonstrates how to implement custom functions for the Expression Editor available in the WinForms End-User Report Designer. In this example, we implement two custom functions.

See also:
How to use a custom function in a query expression

Implementing Custom Functions
How to: Implement a Custom Criteria Language Operator
String.Format Method

This example demonstrates how to create new JSON connections in MVC Dashboard's Data Source wizard and store them in a database.

Set the DashboardExtensionSettings.CanCreateNewJsonDataSource property to True to allow creating new JSON connections. Implement the IDataSourceWizardConnectionStringsStorage interface to create custom connection string storage, and use the DashboardConfigurator's SetConnectionStringsProvider method to assign it to the MVC Dashboard.

In this example, connections are stored in a database using Entity Framework. To run the example, modify the "ConnectionStorage" connection string in Web.config.

Files to look at:

This example describes how to implement an OData v4 service with XPO. This example is an ASP.NET MVC 5 Web API project and provides simple REST API for data access.

Steps to implement:

[C#]
protectedvoidApplication_Start(){GlobalConfiguration.Configuration.Services.Replace(typeof(IBodyModelValidator),newCustomBodyModelValidator());GlobalConfiguration.Configure(WebApiConfig.Register);XpoDefault.DataLayer=ConnectionHelper.CreateDataLayer(AutoCreateOption.SchemaAlreadyExists,true);}publicclassCustomBodyModelValidator:DefaultBodyModelValidator{readonlyConcurrentDictionary<Type,bool>persistentTypes=newConcurrentDictionary<Type,bool>();publicoverrideboolShouldValidateType(Typetype){returnpersistentTypes.GetOrAdd(type,t=>!typeof(IXPSimpleObject).IsAssignableFrom(t));}}

[C#]
publicstaticvoidRegister(HttpConfigurationconfig){config.Count().Filter().OrderBy().Expand().Select().MaxTop(null);ODataModelBuildermodelBuilder=CreateODataModelBuilder();ODataBatchHandlerbatchHandler=newDefaultODataBatchHandler(GlobalConfiguration.DefaultServer);config.MapODataServiceRoute(routeName:"ODataRoute",routePrefix:null,model:modelBuilder.GetEdmModel(),batchHandler:batchHandler);}staticODataModelBuilderCreateODataModelBuilder(){// Include persistent classes to the EdmModel:ODataModelBuilderbuilder=newODataConventionModelBuilder();varcustomers=builder.EntitySet<Customer>("Customers");customers.EntityType.HasKey(t=>t.CustomerID);// ..// Include custom actions and functions into the EdmModel.builder.Function("TotalSalesByYear").Returns<decimal>().Parameter<int>("year");returnbuilder;}

This example illustrates how to fetch data from the Azure SQL data base and show it in the GridControl.

Note that in order to bind any data set to a data-aware control, this data set must implement either the IList or IListSource interface. Refer to the Data Binding help article to learn more.

This example contains sample AdventureWorksLT data. To generate a sample database identical to the one used in this example, follow the Quickstart: Create a single database in Azure SQL Database using the Azure portal, PowerShell, and Azure CLI Microsoft article.

Three Ribbon buttons allow you to bind to a sample Azure database using one of the following methods:

To run this example, you need to:

This example shows how to create a custom model for a Pie Series slice.

See WPF Charting – Customizing a Thanksgiving Pie for more information.

Files to look at:

This example demonstrates how to implement a context menu for editing, adding and deleting rows of dxDataGrid.
Use the onContextMenuPreparing event to create a custom menu. In the event handler, check if the current row is the data row. Then, add the corresponding items ("edit", "insert", "delete") to the e.items array. Handle the onItemClick event for each item. In the event handler, call the editRow, insertRow or removeRow methods to edit the current row, add a new row or remove the current row.

Files to look at: index.html

This example is obsolete. In the latest versions, we suggest using a SchedulerDataStorage component and its built-in approach to bind labels. See the Appointment Labels and Statuses and Label Mappings for details.

This example demonstrates how the grid's standard Edit Form can be used to input and apply identical values to all selected grid rows.

Files to look at:

This example demonstrates how to make the Pivot dashboard item behaves like a single-select Master Filter item. This approach uses several features: filtering by dashboard parameters, access to underlying controls, conditional formatting, and API methods to access the underlying data.

[C#]
voidOnDashboardItemClick(objectsender,DashboardItemMouseActionEventArgse){if(e.DashboardItemName=="pivotDashboardItem1"&&!skipFiltering){dashboardDesigner1.BeginUpdateParameters();//clear all parametersClearPivotFilter();//set selected columns and rows to parametersSetParameterValue(e.GetAxisPoint("Column"));SetParameterValue(e.GetAxisPoint("Row"));dashboardDesigner1.EndUpdateParameters();}}

[C#]
voidClearPivotFilter(){PivotDashboardItempivotItem=dashboardDesigner1.Dashboard.Items["pivotDashboardItem1"]asPivotDashboardItem;ClearParameters(pivotItem.Columns);ClearParameters(pivotItem.Rows);}voidClearParameters(DimensionCollectiondimensions){foreach(vardimensionindimensions)dashboardDesigner1.Parameters[GetParameterDataMember(dimension.DataMember)].SelectedValue=null;}

[C#]
boolskipFiltering=false;privatevoiddashboardDesigner1_DashboardItemControlCreated(objectsender,DevExpress.DashboardWin.DashboardItemControlEventArgse){if(e.DashboardItemName=="pivotDashboardItem1"){e.PivotGridControl.MouseDown+=PivotGridControl_MouseDown;}}privatevoidPivotGridControl_MouseDown(objectsender,MouseEventArgse){PivotGridControlpivot=senderasPivotGridControl;PivotGridHitInfohi=pivot.CalcHitInfo(e.Location);skipFiltering=(hi.ValueInfo!=null&&hi.ValueInfo.ValueHitTest==PivotGridValueHitTest.ExpandButton);}

([Dimension1] = ?Dimension1Param Or ?Dimension1Param Is Null) And
([Dimension2] = ?Dimension2Param Or ?Dimension2Param Is Null) And
...
([DimensionN] = ?DimensionNParam Or ?DimensionNParam Is Null)

([Product] = ?ProductParam Or ?ProductParam Is Null) 
And ([Category] = ?CategoryParam Or ?CategoryParam Is Null) 
And ([Country] = ?CountryParam Or ?CountryParam Is Null) 
And ([City] = ?CityParam Or ?CityParam Is Null)

The steps above are sufficient to implement the minimal filtering functionality. Further steps improve the UI behavior.

(?CityParam Is Not Null Or ?CountryParam Is Not Null Or ?ProductParam Is Not Null Or ?CategoryParam Is Not Null) And ([Product] = ?ProductParam Or ?ProductParam Is Null) And ([Category] = ?CategoryParam Or ?CategoryParam Is Null) And ([Country] = ?CountryParam Or ?CountryParam Is Null) And ([City] = ?CityParam Or ?CityParam Is Null)

[C#]
voidOnCustomizeDashboardItemCaption(objectsender,CustomizeDashboardItemCaptionEventArgse){if(e.DashboardItemName=="pivotDashboardItem1"){DashboardToolbarItemshowDataItem=newDashboardToolbarItem("Clear Master Filter",newAction<DashboardToolbarItemClickEventArgs>((args)=>{dashboardDesigner1.BeginUpdateParameters();ClearPivotFilter();dashboardDesigner1.EndUpdateParameters();}));showDataItem.Enabled=IsAnyFilterSet();showDataItem.SvgImage=svgImageCollection1[0];e.Items.Insert(0,showDataItem);}}

This example shows how to create an extension for the Dashboard Designer / Dashboard Viewer controls that displays detailed data for a clicked pivot element (a data cell or a field value). This extension add the Display Details button to the ribbon, that behaves like default interactivity options. So that end users who design dashboards can enable or disable this functionality in the same manner as Drill-Down, Master Filtering, or other options.

The example contains a solution with two projects:

This approach has the following limitations:

Below you find a step-by-step instruction to create the extension from scratch. You can divide the task implementation to several parts:

[C#]
voidDashboardItemClick(objectsender,DashboardItemMouseActionEventArgse){…using(DetailDatadetailForm=newDetailData(e.GetUnderlyingData())){detailForm.ShowDialog();}}

[C#]
booldoNotShowDataForThisArea=false;voidPivotGridControl_MouseDown(objectsender,MouseEventArgse){PivotGridControlpivot=senderasPivotGridControl;PivotGridHitInfohi=pivot.CalcHitInfo(e.Location);doNotShowDataForThisArea=(hi.HitTest==PivotGridHitTest.Value&&hi.ValueInfo.ValueHitTest==PivotGridValueHitTest.ExpandButton)||(hi.HitTest==PivotGridHitTest.None);}

[C#]
RibbonControlribbon=targetDesigner.MenuManagerasRibbonControl;PivotToolsRibbonPageCategorycategory=ribbon.PageCategories.OfType<PivotToolsRibbonPageCategory>().First();DataRibbonPagepage=category.Pages.OfType<DataRibbonPage>().First();InteractivitySettingsRibbonPageGroupInteractivityGroup=page.Groups.OfType<InteractivitySettingsRibbonPageGroup>().First();

[C#]
List<string>pivotItemsWithEnabledDetails;privatevoidShowDetatilsItem_ItemClick(objectsender,ItemClickEventArgse){if(targetDesigner.SelectedDashboardItemisPivotDashboardItem){if(isDetailsEnabled(targetDesigner.SelectedDashboardItem.ComponentName))pivotItemsWithEnabledDetails.Remove(targetDesigner.SelectedDashboardItem.ComponentName);elsepivotItemsWithEnabledDetails.Add(targetDesigner.SelectedDashboardItem.ComponentName);}UpdateButtonState();}

[C#]
voidDesigner_DashboardItemSelected(objectsender,DashboardItemSelectionChangedEventArgse){if(targetDesigner.Dashboard.Items[e.DashboardItemName]isPivotDashboardItem){UpdateButtonState();}}voidUpdateButtonState(){if(targetDesigner.SelectedDashboardItem==null)return;showDetatilsButton.Checked=IsDetailsEnabled(targetDesigner.SelectedDashboardItem.ComponentName);}

[C#]
privatevoidDesigner_DashboardSaving(objectsender,DashboardSavingEventArgse){XmlSerializerxs=newXmlSerializer(typeof(List<string>));XDocumentxElement=newXDocument();using(XmlWriterxw=xElement.CreateWriter())xs.Serialize(xw,pivotItemsWithEnabledDetails);e.Dashboard.UserData=xElement.Root;}

This example shows how to change a Chart's data source based on a grid's selected row. For this, handle the grid's SingleSelectedDataRowChanged event and filter/update chart's data based on a selected row.

Files to look at:

This example illustrates three discontinuous custom scales for the Timeline view which are properly aligned. The first scale is a day scale which skips Saturdays and Sundays. The second scale is an hour scale which contains only working hours from 6 to 21. The third scale with increments of 30 minutes displays hours from 6 to 21, like the second scale.

This example demonstrates how to create a label report at runtime.

To create a report formatted to fit your labels, it is necessary to adjust some specific layout settings. Users can create labels via the Label Report Wizard with just a few clicks.
However, sometimes it is necessary to create labels at runtime. This example demonstrates which particular report settings must be adjusted for a specific label type.

We created a CustomLabelReportBuilder helper class that follows the report creation algorithm used by our Label Report Wizard. A CustomLabelReportModel class provides the following label settings.

To generate a label report at runtime, call CustomLabelReportBuilder.GenerateLabelReport with a CustomLabelReportModel object or individual settings (listed above) as an argument(s).

Take note of the LabelReportValuesHelper class - it provides methods allowing you to fetch label report type settings, such as the Label Products list and Product Details.

You can provide custom XML files with available Label Product values. For this, pass a path to the a custom XML file to the LabelReportValuesHelper constructor.
To make the default Label Report Wizard use this custom XML, enable the static DevExpress.Data.XtraReports.Labels.LabelWizardCustomization.ExternalLabelProductRepository property at the application startup.

Files to look at: