API/AdHocSettings.md
... ...
@@ -133,87 +133,83 @@ The ``AdHocSettings`` class contains all the settings Izenda uses to control var
133 133
| bool|GenerateParameterizedSql|Gets or sets the value indicating whether queries to the database should be parameterized.|
134 134
| bool|GenerateThumbnails|
135 135
| string|GeoDataTable||Gets or sets the value indicating the table name which contains geodata for maps.|
136
-| GetEqualsSelectValuesDelegate|GetEqualsSelectValues|Represents a method that returns values for Equals_Select operator.
137
-This handles the list of values shown at the Fields tab in the ReportDesigner in the Value(s) combobox if Equals(Select) operator is used.|
138
-| TableItemStyle|GridHeaderStyle||
139
-| TableItemStyle|GridItemStyle||
140
-| System.Drawing.Color|HeaderForegroundColor||
141
-| string|HeaderStyle||
142
-| NameValueCollection|HelpText||
143
-| string[]|HiddenCategories||
144
-| string[]|HiddenColumns||
145
-| List<double>|HiddenTimeZones||
136
+| GetEqualsSelectValuesDelegate|GetEqualsSelectValues|Represents a method that returns values for the "Equals(Select)" operator. This handles the list of values shown on the Fields tab in the ReportDesigner in the Value(s) combobox if the "Equals(Select)" operator is used.|
137
+| TableItemStyle|GridHeaderStyle|Gets or sets the OpenOffice output style for grid headers in the report.|
138
+| TableItemStyle|GridItemStyle|Gets or sets the OpenOffice output style for grid items in the report.|
139
+| System.Drawing.Color|HeaderForegroundColor|Gets or sets the color of the report header.|
140
+| string|HeaderStyle|Gets or sets the CSS style for the headers in the Fields, Summary, and Filters tabs.|
141
+| NameValueCollection|HelpText|Gets or sets the collection of key-value pairs where the key is the tab name and the value is a hint that will be shown when the mouse is over the appropriate tab. Can be seen in the ReportDesigner if the ShowSideHelp property is enabled. <br> *Note: You can also enable/disable side help by clicking the Help button (the ShowHelpButton property must be enabled for this)*.|
142
+| string[]|HiddenCategories|Sets which categories are hidden for the current user. Report from those categories will not be shown to the current user.|
143
+| string[]|HiddenColumns|Gets or sets the array of Column names that should be hidden in the Fields tab dropdowns in the ReportDesigner.|
144
+| HiddenFilterCollection|HiddenFilters|This controls row-level security throughout the application. This should be used in all multi-tenant systems and systems where users are restricted to certain records. Hidden filters are applied to the report being executed. They will not appear in the UI and are invisible to the user.|
146 145
| string|IdentifiersRegex||
147
-| string|ImagesPath||
148
-| bool|InheritFiltersInSubreports||
149
-| string|InstantReport||
150
-| bool|InvalidateSchemaOnNew||
151
-| int|InvertedGridLimit||
152
-| System.Drawing.Color|ItemForegroundColor||
153
-| Unit|JoinDropDownWidth||
154
-| JoinedTablesList|JoinedTablesList||
155
-| string|JoinFieldRegex||
156
-| NameValueCollection|LabelAliases||
157
-| AdHocLanguage|Language||
158
-| char|LiteralComma||
159
-| bool|LockViewer||
160
-| string|LoginUrl||
161
-| MapInfoCollection|MapInfoCollection||
162
-| Size|MaxImageSize||
146
+| string|ImagesPath|Gets or sets the path of the folder that contains the images used by Izenda AdHoc. If the value is not set, then built-in images will be used.|
147
+| bool|InheritFiltersInSubreports|Gets or sets the value indicating whether filters will be inherited in subreports. When enabled, subreports will have filters from the master report applied.|
148
+| string|InstantReport|Gets or sets the URL to the InstantReport page for custom implementations.|
149
+| string|InstantReportWithDelimiter|Gets or sets the URL to the InstantReport page with query string characters appended("?" and "&").|
150
+| bool|InvalidateSchemaOnNew|Gets or sets the value indicating whether the database schema should be invalidated when the user creates new report.|
151
+| int|InvertedGridLimit|Gets or sets the maximum count of rows for an inverted grid. This affects the maximum count of rows when set in the ReportDesigner.<br> *Note: The AllowInvertedGrid property MUST be enabled to use InvertedGridLimit*.|
152
+| System.Drawing.Color|ItemForegroundColor|Gets or sets the default color of the item text on the report grid.|
153
+| Unit|JoinDropDownWidth|Gets or sets the width of the join type dropdowns. These dropdowns can be found at the Data Sources tab of the ReportDesigner when ShowDataSourcesAsCheckBoxes is set to false.|
154
+| string|JoinFieldRegex|Gets or sets a regular expression used to filter certain fields from being shown in the join field between data sources in the data sources tab of report designer. For example, to show only fields ending with "ID", use following value: AdHocSettings.JoinFieldRegex = "^.*(?<!id)$";|
155
+| NameValueCollection|LabelAliases|Gets or sets the collection of key-value pairs where the key is the field name and the value is a field alias.|
156
+| AdHocLanguage|Language|Gets or sets the display language used for Izenda AdHoc.|
157
+| string|LicenseKey|Gets or sets the license key for your distribution of Izenda AdHoc. This is absolutely required for the application to function.
158
+| char|LiteralComma|Gets or sets the delimiter separating items in the 'Equals' filter operator value. This is an actual comma by default for easy copy/paste from CSV format lists.|
159
+| bool|LockViewer|Gets or sets the value indicating whether the Report Viewer will be locked. If true, controls like Add/Remove field, filters control, etc. will be unavailable in the ReportViewer.|
160
+| string|LoginUrl|This setting allows the user to specify their own login page to be utilized by Izenda Reports. Note to utilize this login page the "Require Login" check box must be selected.|
161
+| MapInfoCollection|MapInfoCollection|Gets or sets the registered maps data. This defines the contents of the Map Type dropdown at the Map tab in the ReportDesigner.|
162
+| Size|MaxImageSize|Gets or sets the maximum image size of the report images. If the size of an image is larger than the specified value then the image will be scaled.|
163 163
| int|MaximumReportSizeForCache||
164
-| Unit|MinPdfFontSize||
165
-| bool|MultiLevelVisualGrouping||
166
-| string|MySqlConnectionString||
167
-| string|NoDataSourcePage||
168
-| int|NumChartPerRow||
169
-| int|NumChartTabs||
170
-| int|NumSharedDropdowns||
171
-| bool|OpenCustomUrlInNewWindow||
172
-| int|OracleCommandTimeout||
173
-| string|OracleConnectionString||
174
-| ReportOutputGeneratorCollection|OutputTypes||
164
+| Unit|MinPdfFontSize|Sets the minimum font size that will be used when creating a PDF document. The default is 10 point.|
165
+| string|MySqlConnectionString|Gets or sets the connection string for MySQL connections.|
166
+| string|NoDataSourcePage|Gets or sets the URL of the page where users will be redirected if there are no tables in a database.
167
+By default it is settings page.|
168
+| int|NumChartPerRow|Gets or sets the value indicating the number of charts that should be displayed in one report row on Dashboards.|
169
+| int|NumChartTabs|Sets the maximum number of charts allowed per report in the ReportDesigner. Each chart will have it's own tab in the report designer. Setting this to more than 1 requries a Dashboards license.|
170
+| int|NumSharedDropdowns|Gets or sets the maximum number of user/roles a report can be shared with. This affects the number of "Share With" dropdowns on the Misc tab of the ReportDesigner.|
171
+| bool|OpenCustomUrlInNewWindow|Gets or sets the value to enable opening a new window when a custom url link is clicked (See [[advanced filter settings|/FAQ/UserGuides/4.0 Fields Tab#4.8 Advanced Field Settings Button]]). If this is not enabled, the current page will change to the clicked on the link.|
172
+| int|OracleCommandTimeout|Sets the time Izenda Reports will wait for an Oracle command to execute before timing out.|
173
+| string|OracleConnectionString|Gets or sets the connection string for Oracle Server connections.|
174
+| ReportOutputGeneratorCollection|OutputTypes|Gets or sets the registered ReportOutputGenerators collection. These define what types of formats Izenda AdHoc can export to.|
175 175
| string|ParentReportDesignerUrl||
176 176
| string|ParentReportListUrl||
177 177
| string|ParentReportViewerUrl||
178 178
| string|ParentSettingsUrl||
179
-| bool|PerUserCaching||
180
-| int|PivotFieldLimit||
181
-| string|PostgreSQLConnectionString||
182
-| int|PreviewColumnLimit||
183
-| string|PreviewColumnLimitMessage||
184
-| int|PreviewTimeout||
185
-| PrintMode|PrintMode||
186
-| ProcessFiltersDelegate|ProcessFiltersDelegate||
187
-| int|QuickAddFieldWidth||
188
-| int|QuickAddMinElementsInColumn||
189
-| string|RDLFolder||
179
+| bool|PerUserCaching|Gets or sets the value indicating whether the Driver.DatabaseSchema metadata should be cached.|
180
+| int|PivotFieldLimit|Sets the limit for the maximum number of pivot columns that can exist in a report. See more about [[pivots|/FAQ/UserGuides/12.0 Pivots]].|
181
+| string|PostgreSQLConnectionString|Gets or sets the connection string for Postgre SQL connections.|
182
+| int|PreviewColumnLimit|Gets or sets the value indicating the number of columns to show in the report preview.|
183
+| string|PreviewColumnLimitMessage|Gets or sets the value indicating the message displayed when PreviewColumnLimit is exceeded.|
184
+| int|PreviewTimeout|Sets the minimum time Izenda Reports will wait for a MSSQL command to execute before timing out.|
185
+| PrintMode|PrintMode|Gets or sets the value indicating what print mode will be used, PDF or HTML.|
186
+| int|QuickAddFieldWidth|Gets or sets the value indicating the max length of a string in one [[QuickAdd|/FAQ/UserGuides/4.0 Fields Tab#4.7 Quick Add]] column.|
187
+| int|QuickAddMinElementsInColumn|Set the minimum number of elements in each QuickAdd column.|
188
+| string|RDLFolder|Gets or sets path to Folder where [[RDL|http://technet.microsoft.com/en-us/library/ms155062.aspx]] files would be saved.|
190 189
| int|RecentlyUpdatedCountAtReportList||
191
-| System.Drawing.Color|ReportAlternatingItemColor||
192
-| System.Drawing.Color|ReportBorderColor||
193
-| string|ReportCss||
194
-| string|ReportCssUrl||
195
-| string|ReportDesignerUrl||
196
-| System.Drawing.Color|ReportHeaderColor||
197
-| System.Drawing.Image|ReportHeaderImage||
198
-| string|ReportHeaderImageUrl||
199
-| string|ReportingService2005Url||
200
-| System.Drawing.Color|ReportItemColor||
201
-| string|ReportList||
202
-| ReportListSettings|ReportListSettings||
203
-| ReportSetEventWatcherCollection|ReportSetEventWatchers||
204
-| string|ReportsPath||
205
-| bool|ReportsSharedByDefault||
206
-| StorageMode|ReportStorageMode||
207
-| ReportTypeCollection|ReportTypes||
208
-| string|ReportViewer||
209
-| int|ReportViewerDefaultPreviewResults||
210
-| string|ReportViewerPostHtml||
211
-| string|ReportViewerPreHtml||
212
-| int|ReportViewerRefreshInterval||
213
-| string|ReportViewPageTitle||
214
-| bool|RequireLogin||
215
-| string|ResponseServer||
216
-| int[]|ResultsDropdownValues||
190
+| System.Drawing.Color|ReportAlternatingItemColor|Gets or sets the text color of alternating(even numbered) items in reports. See ReportItemColor for regular(odd numbered) items.|
191
+| System.Drawing.Color|ReportBorderColor|Gets or sets the color of the report border.|
192
+| string|ReportCssUrl|This setting allows the user to specify their own css file to be used on reports generated by Izenda Reports. This setting replaced the ReportCss property and should be used instead.|
193
+| string|ReportDesignerUrl|Gets or sets the URL of a page used to design reports.|
194
+| string|ReportDesignerUrlWithDelimiter|Gets the ReportDesignerUrl with query string characters ("?" and "&") at the end.|
195
+| System.Drawing.Color|ReportHeaderColor|Gets or sets the color of the report header.|
196
+| string|ReportHeaderImageUrl|This setting allows the user to set a report header image to be used on reports. This replaced the property ReportHeaderImage and should be used instead.|
197
+| string|ReportingService2005Url|Gets or sets the base URL of the XML Web service.|
198
+| System.Drawing.Color|ReportItemColor|Gets or sets the text color of regular(odd numbered) items in reports. See ReportAlternatingItemColor for alternating(even numbered) items.|
199
+| string|ReportList|Gets or sets the URL of the report list page. If this is null or empty, the Report List button in the toolbar will be hidden.|
200
+| ReportSetEventWatcherCollection|ReportSetEventWatchers|Gets or sets the collection of registered IReportSetEventWatcher objects that perform various actions on ReportSet-related events.|
201
+| string|ReportsPath|Sets the path to the directory where report files are stored. This is only needed when [[FileSystemMode|/Storing-Reports]] is enabled. Note: Be sure the folder exists and has the correct [[network user permissions|/Integration/Tutorials/Installing-Izenda#Step-3.-Configure-website-under-IIS]] specified.|
202
+| StorageMode|ReportStorageMode|Defines how reports are stored: either in the file system or in the database.|
203
+| string|ReportViewer|Gets or sets the URL of the report viewer page.|
204
+| int|ReportViewerDefaultPreviewResults|This textbox specifies the default number of results in the Report Viewer for all reports. Izenda does not recommend setting this to a large number such as 5000 or larger as the html report will take a long time to generate. If you would like to view all the data, we recommend exporting the report. This will always provide the entire report.|
205
+| string|ReportViewerPostHtml|Gets or sets the string of html that will be placed after the entire HtmlOutputReportResults section. This can be seen in the ReportViewer at the bottom page after the report body.|
206
+| string|ReportViewerPreHtml|Gets or sets the string of html code that placing before the entire HtmlOutputReportResults section. This can be seen in the ReportViewer in the top of the page before the report body.|
207
+| string|ReportViewerWithDelimiter|Gets the url of the report viewer page with query string characters ("?" and "&") at the end.
208
+| string|ReportViewPageTitle|Gets or sets the title of report viewer page. This text can be seen as the title of the browser window when ReportViewer is opened.|
209
+| bool|RequireLogin|This setting tells Izenda Reports that system will use authorization.<br> *Note: The LoginUrl property MUST be specified if this setting is enabled*.|
210
+| string|ResponseServer|Gets or sets the URL of the ResponseServer page.|
211
+| string|ResponseServerWithDelimiter|Gets the URL of the ResponseServer page with query string characters("?" and "&") at the end.|
212
+| int[]|ResultsDropdownValues|Gets or sets the list of the values in the "Results" dropdown in the toolbar of the ReportDesigner. This will override as many default entries in the list as it can.|
217 213
| string|SavedReportsTable||
218 214
| string|SaveReportSetNextUrl||
219 215
| string|ScheduledReportsUrlFormatString||