API/AdHocSettings.md
... ...
@@ -214,8 +214,7 @@ The ``AdHocSettings`` class contains all the settings Izenda uses to control var
214 214
| string|ScheduledReportsUrlFormatString|Gets or sets the url that is sent via email as the report web address when the user selects "link" in the scheduling control's "send email as" field. [[Report scheduling|/FAQ/Questions/How-do-I-use-the-Izenda-Reports-report-email-scheduler]] MUST be turned on for this to have an effect.|
215 215
| SchedulerOutputCollection|SchedulerOutputTypes|Gets or sets the value indicating the allowed formats for scheduling reports. This defines the contents of the "Send Email As" dropdown at the Misc tab in the ReportDesigner.|
216 216
| TimeSpan|SchemaCacheTimeout|Gets or sets how long the system should wait before giving up on caching the schema.|
217
-| Unit|SelectValueDropDownWidth|Gets or sets the width of filter values dropdown.
218
-This affects width of filtering value combobox, which appears at the Filters tab in the ReportDesigner when user selects Equals(Select) operator.|
217
+| Unit|SelectValueDropDownWidth|Gets or sets the width of the "Value(s)" dropdown on the Filters tab in the Report Designer.|
219 218
| string|SettingsKey|Gets or sets a password used to access the settings page. It should be used in tandem with UserKey if you don't need multi-user security.|
220 219
| string|SettingsPageUrl|Gets or sets the URL of the Settings page.|
221 220
| string[]|SharedWithValues|This sets the users or roles available in the "Shared With" dropdown of the Misc tab in the Report Designer.|
... ...
@@ -297,81 +296,81 @@ This affects width of filtering value combobox, which appears at the Filters tab
297 296
| bool|ShowPivot|Gets or sets whether to show the "Add Pivot" button on the Report Designer.|
298 297
| bool|ShowPoweredByLogo|Gets or sets whether to show the "Powered By Izenda" logo throughout the application.|
299 298
| bool|ShowPreviewTab|Gets or sets whether the "Preview" tab is shown in the Report Designer.|
300
-| bool|ShowPublishRdlButton|Gets or sets whether to show the "RDL" button on the Report Designer toolbar.|
301
-| bool|ShowRdlOutputIcon||
302
-| bool|ShowRecentDatasources||
299
+| bool|ShowPublishRdlButton|Gets or sets whether to show the "Publish RDL" button on the Report Designer toolbar.|
300
+| bool|ShowRdlOutputIcon|Gets or sets whether to show the "RDL" button on the Report Designer toolbar.|
301
+| bool|ShowRecentDatasources|Gets or sets the value indicating whether the Recent Datasources dropdown list will be shown on the Data Sources tab of the Report Designer.|
303 302
| bool|ShowRemoveAll||
304 303
| bool|ShowRemoveFieldInReportViewer||
305
-| bool|ShowReportClassifiers||
306
-| bool|ShowReportColor||
307
-| bool|ShowReportingServicesSettings||
308
-| bool|ShowReportsInHtmlOutput||
309
-| bool|ShowReportsListAsDropDown||
310
-| bool|ShowReportsTab||
311
-| bool|ShowResponseServerDetails||
312
-| bool|ShowRowButtons||
313
-| bool|ShowRTFButton||
314
-| bool|ShowSaveAsToolbarButton||
315
-| bool|ShowSaveControls||
316
-| bool|ShowSaveControlsInReportsTab||
317
-| bool|ShowSaveInReportViewer||
318
-| bool|ShowSaveRdlToolbarButton||
319
-| bool|ShowScheduleControls||
320
-| bool|ShowServerEmailButton||
321
-| bool|ShowSettingsButton||
322
-| bool|ShowSettingsButtonForNonAdmins||
323
-| bool|ShowSharedCheckbox||
324
-| bool|ShowSharingControl||
325
-| bool|ShowSideHelp||
326
-| bool|ShowSimpleModeViewer||
327
-| bool|ShowSqlOutputIcon||
328
-| bool|ShowStackTrace||
329
-| bool|ShowStyleTab||
330
-| bool|ShowSummaryLine||
331
-| bool|ShowSummaryTab||
332
-| bool|ShowTableNames||
333
-| bool|ShowTenantField||
334
-| bool|ShowTimeZoneDropdown||
335
-| bool|ShowTopInFields||
336
-| bool|ShowTopInSummary||
337
-| bool|ShowVisualGroupLabels||
338
-| bool|ShowWatermarkedExports||
339
-| bool|ShowWaterMarks||
340
-| bool|ShowWidth||
341
-| bool|ShowXLSButton||
304
+| bool|ShowReportClassifiers|Gets or sets the value indicating whether the ReportClassifiers control should be shown on the "Misc" tab of the ReportDesigner.|
305
+| bool|ShowReportColor|Gets or sets the value indicating whether report color (Item and AlternatingItem) dropdowns are shown on the Style tab in the Report Designer.|
306
+| bool|ShowReportingServicesSettings|Deprecated|
307
+| bool|ShowReportsInHtmlOutput|Deprecated|
308
+| bool|ShowReportsListAsDropDown|Gets or sets the value indicating which mode to use for the Reports tab.|
309
+| bool|ShowReportsTab|Gets or sets whether the Reports tab should be shown on the Report Designer.|
310
+| bool|ShowResponseServerDetails|Gets or sets whether to show a diagnostic test using the Response Server page.|
311
+| bool|ShowRowButtons|Gets or sets the value indicating whether "insert" and "move" buttons should be shown on the Fields tab in the Report Designer.|
312
+| bool|ShowRTFButton|Gets or sets the whether to enable the button to export to RTF format.|
313
+| bool|ShowSaveAsToolbarButton|Gets or sets whether the save as button is shown on the toolbar in Report Designer.|
314
+| bool|ShowSaveControls|Gets or sets whether the save controls (save and save as icons) in the toolbar are shown on the report designer.|
315
+| bool|ShowSaveControlsInReportsTab|Gets or sets the value indicating whether save controls should be shown in the toolbar in the Report Viewer.|
316
+| bool|ShowSaveInReportViewer|Deprecated|
317
+| bool|ShowSaveRdlToolbarButton|Gets or sets the value indicating whether the "Save As RDL" button should be shown on the toolbar.|
318
+| bool|ShowScheduleControls|Defines whether or not the scheduling controls are show at the Misc tab in the Report Designer.|
319
+| bool|ShowServerEmailButton|Gets or sets whether the "E-Mail report from server" button from the Izenda Reports toolbars.|
320
+| bool|ShowSettingsButton|Gets or sets whether the "Settings" button is shown on the toolbar.|
321
+| bool|ShowSettingsButtonForNonAdmins|Gets or sets whether the Settings button will be shown to users without administrator rights.|
322
+| bool|ShowSharedCheckbox|Deprecated|
323
+| bool|ShowSharingControl|Gets or sets the value indicating whether the sharing control will be shown at the Misc tab in the Report Designer.|
324
+| bool|ShowSideHelp|Gets or sets the value indicating whether side help should be shown in the Report Designer.|
325
+| bool|ShowSimpleModeViewer|Gets or sets whether to display the Simple Mode of the Report Viewer.|
326
+| bool|ShowSqlOutputIcon|Deprecated|
327
+| bool|ShowStackTrace|Gets or sets the value indicating the format for showing exceptions.|
328
+| bool|ShowStyleTab|Gets or sets whether the Style tab is shown on the Report Designer page.|
329
+| bool|ShowSummaryLine|Deprecated|
330
+| bool|ShowSummaryTab|Gets or sets whether the summary tab is shown on the Report Designer.|
331
+| bool|ShowTableNames|Gets or sets whether the fields in dropdowns should be grouped by table name. |
332
+| bool|ShowTenantField|Gets or sets whether the field identified in the TenantField property is shown.|
333
+| bool|ShowTimeZoneDropdown|Gets or sets the value indicating whether the timezone dropdown will be shown in the Report Designer on the Misc tab. <br> *Note: ShowScheduleControls MUST be set to true to use this*.|
334
+| bool|ShowTopInFields|Gets or sets whether to display the "Records" textbox on the Fields tab of the Report Designer.|
335
+| bool|ShowTopInSummary|Gets or sets whether to display the "Records" textbox on the Summary tab of the Report Designer.|
336
+| bool|ShowVisualGroupLabels|Deprecated|
337
+| bool|ShowWatermarkedExports|Gets or sets the value indicating whether a watermarked export should be used when there are license errors.|
338
+| bool|ShowWaterMarks|Gets or sets the value indicating whether watermarks should be used when there are license errors.|
339
+| bool|ShowWidth|Deprecated|
340
+| bool|ShowXLSButton|Gets or sets the value indicating whether the "XLS" export button is shown on the toolbar. |
342 341
| string|SimpleFilterCssUrl||
343
-| bool|SingleLineViewerToolbar||
344
-| string|SmtpLogin||
345
-| string|SmtpPassword||
346
-| string|SmtpServer||
347
-| bool|SortColumnNames||
348
-| int|SqlCommandTimeout||
349
-| string|SqlServerConnectionString||
342
+| bool|SingleLineViewerToolbar|Gets or set value indicating whether the ReportViewer toolbar should be single line.|
343
+| string|SmtpLogin|Gets or sets the SMTP server login name.|
344
+| string|SmtpPassword|Gets or sets the SMTP server password.|
345
+| string|SmtpServer|Gets or sets the SMTP server address used by your company to send out emails.|
346
+| bool|SortColumnNames|Gets or sets the value indicating whether dropdowns with column names are sorted alphabetically. |
347
+| int|SqlCommandTimeout|Gets or sets the wait time in seconds for loading dropdowns from the database.|
348
+| string|SqlServerConnectionString|Gets or sets the connection string for MS SQL Server connections.|
350 349
| bool|StoreCurrentReportSetInApplication||
351
-| int|StoredProcedureStringLimit||
352
-| bool|StoreImagesToCache||
350
+| int|StoredProcedureStringLimit|Gets or sets the value indicating the max length of a string returned by a Stored Procedure.|
351
+| bool|StoreImagesToCache|Gets or sets the value indicating how temporary images should be stored.|
353 352
| bool|StrictANSIOuterJoin||
354
-| bool|StripInvalidCharacters||
355
-| string|SubCalculationFilterRegex||
356
-| string|TabBackgroundImageUrl||
357
-| NameDistinctValueCollection|TableAliases||
353
+| bool|StripInvalidCharacters|Gets or sets the value indicating whether invalid characters in report names should be stripped out.|
354
+| string|SubCalculationFilterRegex|Gets or sets whether the user can use a regular expression to filter certain numeric fields from having subcalculation function options when selected in the Fields tab of Report Designer.|
355
+| string|TabBackgroundImageUrl|Gets or sets the path to an image used to customize the look of the tabs on the Report Designer.|
356
+| NameDistinctValueCollection|TableAliases|Deprecated|
358 357
| Unit|TableDropDownWidth|This replaces the property DataSourceDropDownWidth and should be used instead.|
359
-| string|TableFilterRegex||
360
-| string|TabsCss||
361
-| string|TabsCssUrl||
362
-| string|TempFiles||
358
+| string|TableFilterRegex|Gets or sets the regular expression used for table filtering.|
359
+| string|TabsCss|Deprecated. Use TabsCssUrl instead.|
360
+| string|TabsCssUrl|Gets or sets the CSS stylesheet URL to use for the TabStrip.|
361
+| string|TempFiles|Gets or sets the value indicating the path where temporary files are stored.|
363 362
| string|TemplatesPath||
364
-| string|TenantField||
365
-| int|ThumbnailHeight||
366
-| int|ThumbnailWidth||
367
-| Unit|TimePeriodDropDownWidth||
368
-| int|TimeZoneOffset||
369
-| SchedulerTimeZoneCollection|TimeZones||
370
-| string|ToolbarBackgroundImageUrl||
371
-| string|ToolbarBorderColor||
372
-| string|ToolbarCssUrl||
373
-| string|UnCategorizedReportsMenuItemTitle||
374
-| bool|UseAdvancedGauge||
363
+| string|TenantField|The field that will be internally filtered by the current TenantID value. |
364
+| int|ThumbnailHeight|Gets or sets the height of thumbnail images on the Report List.|
365
+| int|ThumbnailWidth|Gets or sets the width of thumbnail images on the Report List.|
366
+| Unit|TimePeriodDropDownWidth|Gets or sets the width of the time period dropdown.|
367
+| int|TimeZoneOffset|Gets or sets the value indicating the time zone offset of the current user in hours.|
368
+| SchedulerTimeZoneCollection|TimeZones|Gets or sets the collection of additional and hidden time zones. |
369
+| string|ToolbarBackgroundImageUrl|Gets or sets a URL to an image to customize the look of the toolbar section of the report designer.|
370
+| string|ToolbarBorderColor|Gets or sets the color of the toolbar border.|
371
+| string|ToolbarCssUrl|Gets or sets the CSS stylesheet URL for the Toolbar.|
372
+| string|UnCategorizedReportsMenuItemTitle|Deprecated|
373
+| bool|UseAdvancedGauge|Gets or sets the value indicating whether advanced is used for "Gauge" format. |
375 374
| bool|UseBulkCSV||
376 375
| bool|UseColumnNameForDashboardCommonFilters||
377 376
| bool|UseConstraintsForJoins||