Skip to content

Commit

Permalink
Master (#220)
Browse files Browse the repository at this point in the history
* update to new doc fx (#216)

* update to new doc fx

* Update README.md

* fix matomo

updated partial for 'default', added layout for modern, fix parameters to pass metadata

* Apply suggestions from code review

Co-authored-by: pollyndos <[email protected]>

* add gitignore

* add license

* fix word order

* move note

---------

Co-authored-by: Sergey Avramenko <[email protected]>
Co-authored-by: pollyndos <[email protected]>

* update dashboard parameters (#218)

* update web dashboard

* update winforms part

* fix links

* fix links

* update links to ~

* fix slashes

---------

Co-authored-by: Sergey Avramenko <[email protected]>
Co-authored-by: pollyndos <[email protected]>
  • Loading branch information
3 people authored Oct 2, 2024
1 parent e3780a4 commit 835b52c
Show file tree
Hide file tree
Showing 23 changed files with 38 additions and 38 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This adds the **Text Box Editor** context category to the Dashboard Designer's r

![TextBoxEditorContextCategory](../../../../images/img123328.png)

To learn how to edit the content within the Text Box, see [Rich Text Editor](../../../../../interface-elements-for-desktop/articles/rich-text-editor.md). After you change the document, click **Edit** again to finish editing.
To learn how to edit the content within the Text Box, see [Rich Text Editor](~/interface-elements-for-desktop/articles/rich-text-editor.md). After you change the document, click **Edit** again to finish editing.

> [!NOTE]
> Note that the Text Box can be [bound](../../bind-dashboard-items-to-data.md) to data. To learn how to do this, see [Providing Data](providing-data.md).
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ These functions can be used for all types of numeric fields. After creating such

## Custom Aggregate Functions

Along with the predefined aggregations (like Min, Max, Sum, Avg), the Dashboard supports custom aggregation functions. A custom aggregate function appears in the [Expression Editor](../../../../../interface-elements-for-desktop/articles/expression-editor.md)'s categories if the function was registered in your application.
Along with the predefined aggregations (like Min, Max, Sum, Avg), the Dashboard supports custom aggregation functions. A custom aggregate function appears in the [Expression Editor](~/interface-elements-for-desktop/articles/expression-editor.md)'s categories if the function was registered in your application.

The following image illustrates the custom _StringConcat_ function in the **Aggregate** function’s category:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ To apply filtering to a data source, click the **Filter** button in the **Data S

![Data Source Filter Button](../../../../images/datasourcefiltering_filterbutton_ribbon22300.png)

In the invoked [Filter Editor](../../../../../interface-elements-for-desktop/articles/filter-editor/filter-data-via-the-filter-editor.md), specify the filter criteria. To compare a field value with a parameter value, click the ![Parameters_FilterEditor_CompareButton](../../../../images/parameters_filtereditor_comparebutton21820.png) button and then the ![Parameters_FilterEditor_CompareButton2](../../../../images/parameters_filtereditor_comparebutton221824.png) button. Then, click the second operand's placeholder to invoke the list of available parameters and select the required parameter:
In the invoked [Filter Editor](~/interface-elements-for-desktop/articles/filter-editor/filter-data-via-the-filter-editor.md), specify the filter criteria. To compare a field value with a parameter value, click the ![Parameters_FilterEditor_CompareButton](../../../../images/parameters_filtereditor_comparebutton21820.png) button and then the ![Parameters_FilterEditor_CompareButton2](../../../../images/parameters_filtereditor_comparebutton221824.png) button. Then, click the second operand's placeholder to invoke the list of available parameters and select the required parameter:

![Data Source Filtering - Filter Criteria with a Parameter](../../../../images/filter-ds-parameterpselection-win.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ Filters that apply to a [dashboard item](../dashboard-item-settings.md) affect o

![DataShaping_Filtering_EditFilterMenuItem](../../../images/datashaping_filtering_editfiltermenuitem19369.png)

This invokes the [Filter Editor](../../../../interface-elements-for-desktop/articles/filter-editor/filter-data-via-the-filter-editor.md) dialog that allows you to build complex filter criteria:
This invokes the [Filter Editor](~/interface-elements-for-desktop/articles/filter-editor/filter-data-via-the-filter-editor.md) dialog that allows you to build complex filter criteria:

![DataShaping_Filtering_FilterEditor](../../../images/datashaping_filtering_filtereditor19370.png)

> [!Tip]
> **Documentation**: [Filter Editor](../../../../interface-elements-for-desktop/articles/filter-editor/filter-data-via-the-filter-editor.md)
> **Documentation**: [Filter Editor](~/interface-elements-for-desktop/articles/filter-editor/filter-data-via-the-filter-editor.md)
To clear the applied filter, select **Clear** from the dashboard item's context menu or click the **Clear** button in the **Data** Ribbon tab.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To create a new data extract from the existing data source, perform the followin
4. **(Conditional)** The next page only appears if you are creating the data extract based on the Entity Framework or Object data sources, and allows you to select the required fields.

![DataSourceWizard_Extract_SelectFields](../../../images/img123955.png)
5. On the next page, you can specify the filter used to extract data. To learn how to specify the filter criteria, see [Filter Data via the Filter Editor](../../../../interface-elements-for-desktop/articles/filter-editor/filter-data-via-the-filter-editor.md).
5. On the next page, you can specify the filter used to extract data. To learn how to specify the filter criteria, see [Filter Data via the Filter Editor](~/interface-elements-for-desktop/articles/filter-editor/filter-data-via-the-filter-editor.md).

![DataSourceWizard_Extract_FilterData](../../../images/img123131.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This document describes the **Print Preview** window, which displays the dashboa
![PrintPreviewRibbon](../../../images/img22919.png)

## Specific Options
In the Print Preview, you can change the orientation and size of the printed page, specify the margins, scale the document, etc. To learn more, see [Print Preview for WinForms](../../../../interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms.md).
In the Print Preview, you can change the orientation and size of the printed page, specify the margins, scale the document, etc. To learn more, see [Print Preview for WinForms](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms.md).

You can also customize printing options specific to a dashboard/dashboard item. To do this, click the **Options** button in the **Print** group.
When previewing the dashboard, the following **Options** dialog will be invoked.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ This menu contains the following items.

| Item | Description |
|---|---|
| **Edit Expression...** | Invokes the [Expression Editor](../../../../interface-elements-for-desktop/articles/expression-editor.md) dialog, which allows you to change an expression for an existing calculated field. |
| **Edit Expression...** | Invokes the [Expression Editor](~/interface-elements-for-desktop/articles/expression-editor.md) dialog, which allows you to change an expression for an existing calculated field. |
| **Field Type** | Specifies the type of the calculated field. |
| **Rename** | Changes the calculated field name. |
| **Delete** | Removes the existing calculated field from the data source. |
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ To filter data in the Query Builder, click the **Filter...** button... in the **

![EditQueriesButton_Ribbon](../../../images/img118162.png)

... or use a corresponding button within the [Query Builder](using-the-query-builder.md). This will invoke the [Filter Editor](../../../../interface-elements-for-desktop/articles/filter-editor/filter-data-via-the-filter-editor.md) dialog, which allows you to build filter criteria.
... or use a corresponding button within the [Query Builder](using-the-query-builder.md). This will invoke the [Filter Editor](~/interface-elements-for-desktop/articles/filter-editor/filter-data-via-the-filter-editor.md) dialog, which allows you to build filter criteria.

![FilterEditorDialog_SqlDataSource](../../../images/img121069.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ The steps below create cascading parameters in the Web Dashboard:
![Dashboard for Web - Filter Query](../../../../images/web-filter-properties.png)


In the [Filter Editor](../../ui-elements/dialogs-and-wizards/filter-editor.md), specify the filter criteria. From the drop-down list select *Parameter* and create a new [query parameter](../../provide-data/working-with-sql-data-sources//pass-query-parameters.md) called **categoryQueryParam**:
In the [Filter Editor](../../ui-elements/dialogs-and-wizards/filter-editor.md), specify the filter criteria. From the drop-down list select *Parameter* and create a new [query parameter](../../provide-data/working-with-sql-data-sources/pass-query-parameters.md) called **categoryQueryParam**:

![Dashboard for Web - Filter Query](../../../../images/web-category-parameter-filter-cascading.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This topic describes how to reference a dashboard parameter in [filter strings](
## SQL Queries and Stored Procedures

You can filter the SQL data sources dynamically if you bind a [query parameter](../../provide-data/working-with-sql-data-sources//pass-query-parameters.md) to a dashboard parameter.
You can filter the SQL data sources dynamically if you bind a [query parameter](../../provide-data/working-with-sql-data-sources/pass-query-parameters.md) to a dashboard parameter.

Invoke the **Data Source Wizard** window or use the **Properties** section of the [Query Builder](../../ui-elements/dialogs-and-wizards/query-builder.md) to access the query parameter settings. Change the query parameter type to *Expression* and specify the expression with a dashboard parameter in the **Value** field:

Expand All @@ -22,7 +22,7 @@ The resulting query parameter settings may appear as follows:

![Query Parameter - Expression Type with Parameter](../../../../images/wdd-query-parameters-parameter-expression.png)

Refer to the following article for more information about query parameters: [Use Query Parameters](../../provide-data/working-with-sql-data-sources//pass-query-parameters.md).
Refer to the following article for more information about query parameters: [Use Query Parameters](../../provide-data/working-with-sql-data-sources/pass-query-parameters.md).

>[!TIP]
>For information on how to filter Excel, Object, XPO, and JSON data sources, refer to the following article: [Filter Data Sources](../../provide-data/filter-data-sources.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ The following DevExpress products extend and/or override this syntax. The table

|Product | Article |
|---|---|
|Reporting | [Expression Constants, Operators, and Functions](/reporting-for-desktop/report-designer/report-designer-for-winforms/use-expressions/expression-language.md)
|Reporting | [Expression Constants, Operators, and Functions](~/reporting-for-desktop/report-designer/report-designer-for-winforms/use-expressions/expression-language.md)
|Pivot Grid | [Pivot Grid Expression Syntax](../pivot-table/data-editing/pivot-grid-expression-syntax.md)

## Operators
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,5 +24,5 @@ These settings affect the layout of the report's design surface. After their mod

![](../../../../images/eurd-win-report-controls-printing-warning.png)

You can also modify the page settings in [Print Preview](../preview-print-and-export-reports.md) using the [Page Setup](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/printing-and-page-setup/change-printing-settings-via-the-page-setup-dialog.md) dialog.
You can also modify the page settings in [Print Preview](../preview-print-and-export-reports.md) using the [Page Setup](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/printing-and-page-setup/change-printing-settings-via-the-page-setup-dialog.md) dialog.

Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ To switch a report to the print preview mode, click the **Preview** tab. You wil
![eurd-win-preview](../../../images/eurd-win-preview.png)

> [!NOTE]
> To learn more about the options available in the print preview mode, refer to the [Print Preview for WinForms](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms.md) section of this documentation.
> To learn more about the options available in the print preview mode, refer to the [Print Preview for WinForms](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms.md) section of this documentation.

## Print a Report
Expand All @@ -25,13 +25,13 @@ When in the Print Preview mode, you can export your report to files in different


The following documents describe the basics of report exporting and format-specific export options.
* [Exporting from Print Preview](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/exporting-from-print-preview.md)
* [PDF-Specific Export Options](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/pdf-specific-export-options.md)
* [HTML-Specific Export Options](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/html-specific-export-options.md)
* [MHT-Specific Export Options](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/mht-specific-export-options.md)
* [RTF-Specific Export Options](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/rtf-specific-export-options.md)
* [XLS-Specific Export Options](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/xls-specific-export-options.md)
* [XLSX-Specific Export Options](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/xlsx-specific-export-options.md)
* [CSV-Specific Export Options](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/csv-specific-export-options.md)
* [TXT-Specific Export Options](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/txt-specific-export-options.md)
* [Image-Specific Export Options](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/image-specific-export-options.md)
* [Exporting from Print Preview](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/exporting-from-print-preview.md)
* [PDF-Specific Export Options](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/pdf-specific-export-options.md)
* [HTML-Specific Export Options](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/html-specific-export-options.md)
* [MHT-Specific Export Options](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/mht-specific-export-options.md)
* [RTF-Specific Export Options](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/rtf-specific-export-options.md)
* [XLS-Specific Export Options](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/xls-specific-export-options.md)
* [XLSX-Specific Export Options](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/xlsx-specific-export-options.md)
* [CSV-Specific Export Options](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/csv-specific-export-options.md)
* [TXT-Specific Export Options](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/txt-specific-export-options.md)
* [Image-Specific Export Options](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/image-specific-export-options.md)
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ Follow the steps below to calculate a summary:
![summary-expressions-label-smart-tag](../../../../../images/eurd-label-summaryeditor.png)

> [!TIP]
> See the [Expression Operators, Functions and Constants](/interface-elements-for-desktop/articles/expression-editor/expression-operators-functions-and-constants.md) topic for a complete list of supported summary functions.
> See the [Expression Operators, Functions and Constants](~/interface-elements-for-desktop/articles/expression-editor/expression-operators-functions-and-constants.md) topic for a complete list of supported summary functions.
2. You can use the **Format String** property to format the summary value:

![summary-format-string-label-smart-tag](../../../../../images/eurd-summary-label-details.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ This tutorial illustrates how to filter data at the report data source level, as

![](../../../../../images/eurd-win-filer-data-source-filter-string-property.png)

5. In the invoked [Filter Editor](/interface-elements-for-desktop/articles//filter-editor.md), construct an expression where the data fields are compared with the required values as shown below.
5. In the invoked [Filter Editor](~/interface-elements-for-desktop/articles/filter-editor.md), construct an expression where the data fields are compared with the required values as shown below.

![](../../../../../images/eurd-win-filer-data-source-filter-string.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This tutorial illustrates how to filter data at the report level, as opposed to

4. Click the report's smart tag and click the **Filter String** property's ellipsis button.

In the invoked [FilterString Editor](/interface-elements-for-desktop/articles/filter-editor.md), construct an expression in which the data fields are compared with the required values.
In the invoked [FilterString Editor](~/interface-elements-for-desktop/articles/filter-editor.md), construct an expression in which the data fields are compared with the required values.

![](../../../../../images/eurd-win-filter-data-report-level-filter-string.png)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,4 @@ When switching to [Print Preview](../preview-print-and-export-reports.md), you c
![](../../../../images/eurd-win-format-data-result.png)


You can use the control's **Xlsx Format String** property to assign a native Excel format that is used for exporting reports to [XLSX](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/xlsx-specific-export-options.md).
You can use the control's **Xlsx Format String** property to assign a native Excel format that is used for exporting reports to [XLSX](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/xlsx-specific-export-options.md).
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ For the [Code 128](code-128.md) symbology, you can also define **FNC2-4** charac
For the list of the available application identifiers, refer to the official documentation at [www.gs1.org](http://www.gs1.org/).

## Specify the Barcode Resolution on Export to Third-Party Formats
At present, only [export to PDF](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/pdf-specific-export-options.md) preserves the original barcode in its vector form. Export to other formats will keep only the rasterized version of a barcode (with the default DPI set to **96**).
At present, only [export to PDF](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/pdf-specific-export-options.md) preserves the original barcode in its vector form. Export to other formats will keep only the rasterized version of a barcode (with the default DPI set to **96**).

For [XLSX](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/xlsx-specific-export-options.md) and [XLS](/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/xls-specific-export-options.md) export, the output resolution can be set up manually using the **Rasterization Resolution** property.
For [XLSX](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/xlsx-specific-export-options.md) and [XLS](~/interface-elements-for-desktop/articles/print-preview/print-preview-for-winforms/exporting/xls-specific-export-options.md) export, the output resolution can be set up manually using the **Rasterization Resolution** property.

## Specify the DPI of the Device Used to Print the Bar Code

Expand Down
Loading

0 comments on commit 835b52c

Please sign in to comment.