dfbd781ef97bcbd81bbdc924a7e0a4529832d10b
API/AdHocSettings.md
| ... | ... | @@ -4,62 +4,34 @@ The ``AdHocSettings`` class contains all the settings Izenda uses to control var |
| 4 | 4 | |
| 5 | 5 | |Datatype|Setting name|Setting description|Default Value| |
| 6 | 6 | |:-------|:----------:|:-----------------:|:-----------:| |
| 7 | -|string|[[AddAllFilterRegex|API/CodeSamples/AddAllFilterRegex]]|Gets or sets a regular expression to filter data source fields that can be added with the "Add All" button.|(id|guid)$ |
|
| 8 | -| |
|
| 9 | -| Dictionary<string,double>|[[AdditionalTimeZones |API/CodeSamples/AdditionalTimeZones ]]||System.Collections.Generic.Dictionary`2[System.String,System.Double] |
|
| 10 | -| |
|
| 11 | -| AdHocConfig|[[AdHocConfig|http://wiki.izenda.us/Integration/Tutorials/Customizing-Izenda-Settings]]|Gets or sets the current Ad Hoc configuration.|Izenda.AdHoc.FileSystemAdHocConfig |
|
| 12 | -| |
|
| 13 | -| string|[[AdHocUserKey|API/CodeSamples/AdHocUserKey]]|Gets or sets the password limiting access to the report designer, report list, and report viewer. This is for projects that do not need multi-user security.| |
|
| 14 | -| |
|
| 15 | -| AggregateFunctionCollection|[[AggregateFunctions|API/CodeSamples/AggregateFunctions]]||Izenda.AdHoc.AggregateFunctionCollection |
|
| 16 | -| |
|
| 17 | -| bool|[[AllowAnalysisGrid|API/CodeSamples/AllowAnalysisGrid]]|Gets or sets the value indicating whether to include Analysis Grid in the Visual Group Style field.|True |
|
| 18 | -| |
|
| 19 | -| bool|[[AllowArchivedReportTableCreation|API/CodeSamples/AllowArchivedReportTableCreation]]|Gets or sets whether to allow the application to create an archived reports table on the database.|True |
|
| 20 | -| |
|
| 21 | -| bool|[[AllowClientSorting|API/CodeSamples/AllowClientSorting]]||True |
|
| 22 | -| |
|
| 23 | -| bool|[[AllowComparativeArithmetic|API/CodeSamples/AllowComparativeArithmetic]]|Gets or sets the value indicating whether comparative arithmetic is allowed in arithmetic checkbox. Comparative operators appear in "A" checkboxes at the Fields tab in the ReportDesigner.|False |
|
| 24 | -| |
|
| 25 | -| bool|[[AllowCreateNewCategory|API/CodeSamples/AllowCreateNewCategory]]|Gets or sets the value indicating the possibility to create new categories in Save As dialog in the ReportDesigner.|True |
|
| 26 | -| |
|
| 27 | -| bool|[[AllowDataFieldsInDescription|API/CodeSamples/AllowDataFieldsInDescription]]|Gets or sets whether data fields can be used in report descriptions.|True |
|
| 28 | -| |
|
| 29 | -| bool|[[AllowDeletingReports|API/CodeSamples/AllowDeletingReports]]|This checkbox enables/disables the delete icons at the report list page against reports names, for the current user. Clicking on the red x delete icon deletes the report.|True |
|
| 30 | -| |
|
| 31 | -| bool|[[AllowDeltas|API/CodeSamples/AllowDeltas]]|Gets or sets the value indicating whether "Add Deltas" checkbox should be shown at the fields tab in the ReportDesigner. Any time there is a change in a quantity that change is calculated by taking the later value for that quantity and subtracting from it the earlier value for that quantity.|False |
|
| 32 | -| |
|
| 33 | -| bool|[[AllowDomainJoin|API/CodeSamples/AllowDomainJoin]]|Gets or sets the value indicating that domain joins should be shown on the report designer. Domain join could be useful if you want to join tables on columns with web addresses. For example, if you set up Domain Join option columns with strings "http://www.yourdomain.com" and "www.yourdomain.com" will be equal.|False |
|
| 34 | -| |
|
| 35 | -| bool|[[AllowEqualsSelectForStoredProcedures|API/CodeSamples/AllowEqualsSelectForStoredProcedures]]|Gets or sets the value indicating is it allowed to use Equals(Select) or Equals(Multiple) for filters in case when stored procedure used. These options can be found in the Operator dropdown at the Filters tab in the ReportDesigner.|False |
|
| 36 | -| |
|
| 37 | -| bool|[[AllowFieldsAsValue|API/CodeSamples/AllowFieldsAsValue]]|Gets or sets the value indicating whether field name is allowed in filter value. If set, values like "Is Less Than (Field)" appear in the Operator combobox at the Filters tab in the ReportDesigner. Fields comparison allows you to compare values from one field with values from another field.|True |
|
| 38 | -| |
|
| 39 | -| bool|[[AllowGroupWithoutSelect|API/CodeSamples/AllowGroupWithoutSelect]]|Gets or sets value indicating if it is possible to make invisible fields which are used for Visual Grouping. If set, fields with both "Hide This Field" (in the advanced properties) and "VG"; flags set, will not lead to report being considered as invalid.|False |
|
| 40 | -| |
|
| 41 | -| bool|[[AllowHorizontalBarChart|API/CodeSamples/AllowHorizontalBarChart]]|Gets or sets the value indicating whether Horizontal Bar Chart is allowed. This defines if Horizontal checkbox will be available in the Advanced Properties at the Chart tab in the ReportDesigner, when Bar chart type is used.|True |
|
| 42 | -| |
|
| 43 | -| bool|[[AllowHtmlOutputsInScheduledReports|API/CodeSamples/AllowHtmlOutputsInScheduledReports]]||True |
|
| 44 | -| |
|
| 45 | -| bool|[[AllowInvalidCharacters|API/CodeSamples/AllowInvalidCharacters]]|Gets or sets the value indicating whether invalid characters in report namesare allowed if not striped. If disabled, non-literal characters in the report name, entered in the Report Designer in Save As dialog, will cause error message during saving report. <br>*Note: Invalid characters will be automatically removed from the report name if [[StripInvalidCharacters]] set to true.*|False |
|
| 46 | -| |
|
| 47 | -| bool|[[AllowInvertedGrid|API/CodeSamples/AllowInvertedGrid]]|Allows the inverted checkbox to be shown in the Summary tab in the ReportDesigner. Inverted grid means it exchanges columns for rows (up to 36 rows)|False |
|
| 48 | -| |
|
| 49 | -| bool|[[AllowLineOnBar|API/CodeSamples/AllowLineOnBar]]|Gets or sets the value indicating whether is it allowed line on Bar chart. If true, then Line Value feature is available at the Chart tab in the ReportDesigner, when Bar chart type is selected. Line can show additional values on the Bar chart.|True |
|
| 50 | -| |
|
| 51 | -| bool|[[AllowMultilineHeaders|API/CodeSamples/AllowMultilineHeaders]]|Gets or sets whether headers in the grid report can be multi-line. This setting could be useful if you have many columns in the report or columns names are very long.|False |
|
| 52 | -| |
|
| 53 | -| bool|[[AllowNewFiltersInReportViewer|API/CodeSamples/AllowNewFiltersInReportViewer]]|Gets or sets whether users have the ability to add new filters in the report viewer page of Izenda Reports. <br>*Note: Current filters used on the report will still be displayed.*|True |
|
| 54 | -| |
|
| 55 | -| bool|[[AllowOverwritingReports|API/CodeSamples/AllowOverwritingReports]]|This enables/disables the current user's ability to overwrite reports currently saved. An example of this usage is that many users create base reports for their users to use. Disabling the overwrite report feature ensures that the default reports are not tampered with.|True |
|
| 56 | -| |
|
| 57 | -| bool|[[AllowSelfJoin|API/CodeSamples/AllowSelfJoin]]|Gets or sets the value indicating whether is it allowed datasources self join. If true and ShowDataSourcesAsCheckBoxes, then user can select the same data source twice and selfjoin it at the Data Sources tab in the ReportDesigner.|True |
|
| 58 | -| |
|
| 59 | -| bool|[[AllowStackedBarChart|API/CodeSamples/AllowStackedBarChart]]|Gets or sets the value indicating whether Stacked Bar Chart is allowed. This defines if Stacked checkbox will be available in the Advanced Properties at the Chart tab in the ReportDesigner, when Bar chart type is used.|True |
|
| 60 | -| |
|
| 61 | -| bool|[[AllowSummaryDeltas|API/CodeSamples/AllowSummaryDeltas]]|Gets or sets the value indicating whether the "Show Summary Deltas" checkbox should be shown in the summary tab in the ReportDesigner. Any time there is a change in a quantity, that change is calculated by taking the later value for that quantity and subtracting from it the earlier value for that quantity. The AllowDeltas feature MUST be turned on to use this feature.|True |
|
| 62 | -| |
|
| 7 | +|string|[[AddAllFilterRegex|API/CodeSamples/AddAllFilterRegex]]|Gets or sets a regular expression to filter data source fields that can be added with the "Add All" button.|(id|guid)$| |
|
| 8 | +| Dictionary<string,double>|[[AdditionalTimeZones |API/CodeSamples/AdditionalTimeZones ]]||Empty list| |
|
| 9 | +| AdHocConfig|[[AdHocConfig|http://wiki.izenda.us/Integration/Tutorials/Customizing-Izenda-Settings]]|Gets or sets the current Ad Hoc configuration.|new FileSystemAdHocConfig()| |
|
| 10 | +| string|[[AdHocUserKey|API/CodeSamples/AdHocUserKey]]|Gets or sets the password limiting access to the report designer, report list, and report viewer. This is for projects that do not need multi-user security.|string.Empty()| |
|
| 11 | +| AggregateFunctionCollection|[[AggregateFunctions|API/CodeSamples/AggregateFunctions]]||Empty list| |
|
| 12 | +| bool|[[AllowAnalysisGrid|API/CodeSamples/AllowAnalysisGrid]]|Gets or sets the value indicating whether to include Analysis Grid in the Visual Group Style field.|True| |
|
| 13 | +| bool|[[AllowArchivedReportTableCreation|API/CodeSamples/AllowArchivedReportTableCreation]]|Gets or sets whether to allow the application to create an archived reports table on the database.|True| |
|
| 14 | +| bool|[[AllowClientSorting|API/CodeSamples/AllowClientSorting]]||True| |
|
| 15 | +| bool|[[AllowComparativeArithmetic|API/CodeSamples/AllowComparativeArithmetic]]|Gets or sets the value indicating whether comparative arithmetic is allowed in arithmetic checkbox. Comparative operators appear in "A" checkboxes at the Fields tab in the ReportDesigner.|False| |
|
| 16 | +| bool|[[AllowCreateNewCategory|API/CodeSamples/AllowCreateNewCategory]]|Gets or sets the value indicating the possibility to create new categories in Save As dialog in the ReportDesigner.|True| |
|
| 17 | +| bool|[[AllowDataFieldsInDescription|API/CodeSamples/AllowDataFieldsInDescription]]|Gets or sets whether data fields can be used in report descriptions.|True| |
|
| 18 | +| bool|[[AllowDeletingReports|API/CodeSamples/AllowDeletingReports]]|This checkbox enables/disables the delete icons at the report list page against reports names, for the current user. Clicking on the red x delete icon deletes the report.|True| |
|
| 19 | +| bool|[[AllowDeltas|API/CodeSamples/AllowDeltas]]|Gets or sets the value indicating whether "Add Deltas" checkbox should be shown at the fields tab in the ReportDesigner. Any time there is a change in a quantity that change is calculated by taking the later value for that quantity and subtracting from it the earlier value for that quantity.|False| |
|
| 20 | +| bool|[[AllowDomainJoin|API/CodeSamples/AllowDomainJoin]]|Gets or sets the value indicating that domain joins should be shown on the report designer. Domain join could be useful if you want to join tables on columns with web addresses. For example, if you set up Domain Join option columns with strings "http://www.yourdomain.com" and "www.yourdomain.com" will be equal.|False| |
|
| 21 | +| bool|[[AllowEqualsSelectForStoredProcedures|API/CodeSamples/AllowEqualsSelectForStoredProcedures]]|Gets or sets the value indicating is it allowed to use Equals(Select) or Equals(Multiple) for filters in case when stored procedure used. These options can be found in the Operator dropdown at the Filters tab in the ReportDesigner.|False| |
|
| 22 | +| bool|[[AllowFieldsAsValue|API/CodeSamples/AllowFieldsAsValue]]|Gets or sets the value indicating whether field name is allowed in filter value. If set, values like "Is Less Than (Field)" appear in the Operator combobox at the Filters tab in the ReportDesigner. Fields comparison allows you to compare values from one field with values from another field.|True| |
|
| 23 | +| bool|[[AllowGroupWithoutSelect|API/CodeSamples/AllowGroupWithoutSelect]]|Gets or sets value indicating if it is possible to make invisible fields which are used for Visual Grouping. If set, fields with both "Hide This Field" (in the advanced properties) and "VG"; flags set, will not lead to report being considered as invalid.|False| |
|
| 24 | +| bool|[[AllowHorizontalBarChart|API/CodeSamples/AllowHorizontalBarChart]]|Gets or sets the value indicating whether Horizontal Bar Chart is allowed. This defines if Horizontal checkbox will be available in the Advanced Properties at the Chart tab in the ReportDesigner, when Bar chart type is used.|True| |
|
| 25 | +| bool|[[AllowHtmlOutputsInScheduledReports|API/CodeSamples/AllowHtmlOutputsInScheduledReports]]||True| |
|
| 26 | +| bool|[[AllowInvalidCharacters|API/CodeSamples/AllowInvalidCharacters]]|Gets or sets the value indicating whether invalid characters in report namesare allowed if not striped. If disabled, non-literal characters in the report name, entered in the Report Designer in Save As dialog, will cause error message during saving report. <br>*Note: Invalid characters will be automatically removed from the report name if [[StripInvalidCharacters]] set to true.*|False| |
|
| 27 | +| bool|[[AllowInvertedGrid|API/CodeSamples/AllowInvertedGrid]]|Allows the inverted checkbox to be shown in the Summary tab in the ReportDesigner. Inverted grid means it exchanges columns for rows (up to 36 rows)|False| |
|
| 28 | +| bool|[[AllowLineOnBar|API/CodeSamples/AllowLineOnBar]]|Gets or sets the value indicating whether is it allowed line on Bar chart. If true, then Line Value feature is available at the Chart tab in the ReportDesigner, when Bar chart type is selected. Line can show additional values on the Bar chart.|True| |
|
| 29 | +| bool|[[AllowMultilineHeaders|API/CodeSamples/AllowMultilineHeaders]]|Gets or sets whether headers in the grid report can be multi-line. This setting could be useful if you have many columns in the report or columns names are very long.|False| |
|
| 30 | +| bool|[[AllowNewFiltersInReportViewer|API/CodeSamples/AllowNewFiltersInReportViewer]]|Gets or sets whether users have the ability to add new filters in the report viewer page of Izenda Reports.|True| |
|
| 31 | +| bool|[[AllowOverwritingReports|API/CodeSamples/AllowOverwritingReports]]|This enables/disables the current user's ability to overwrite reports currently saved. An example of this usage is that many users create base reports for their users to use. Disabling the overwrite report feature ensures that the default reports are not tampered with.|True| |
|
| 32 | +| bool|[[AllowSelfJoin|API/CodeSamples/AllowSelfJoin]]|Gets or sets the value indicating whether is it allowed datasources self join. If true and ShowDataSourcesAsCheckBoxes, then user can select the same data source twice and selfjoin it at the Data Sources tab in the ReportDesigner.|True| |
|
| 33 | +| bool|[[AllowStackedBarChart|API/CodeSamples/AllowStackedBarChart]]|Gets or sets the value indicating whether Stacked Bar Chart is allowed. This defines if Stacked checkbox will be available in the Advanced Properties at the Chart tab in the ReportDesigner, when Bar chart type is used.|True| |
|
| 34 | +| bool|[[AllowSummaryDeltas|API/CodeSamples/AllowSummaryDeltas]]|Gets or sets the value indicating whether the "Show Summary Deltas" checkbox should be shown in the summary tab in the ReportDesigner. Any time there is a change in a quantity, that change is calculated by taking the later value for that quantity and subtracting from it the earlier value for that quantity. The AllowDeltas feature MUST be turned on to use this feature.|True| |
|
| 63 | 35 | | bool|[[AllowVisualGroups|API/CodeSamples/AllowVisualGroups]]||True |
| 64 | 36 | | |
| 65 | 37 | | string|[[ApplicationHeaderImageUrl|API/CodeSamples/ApplicationHeaderImageUrl]]|Gets or sets the URL of the Application Header Logo.| |