#ReportSet
##Properties
| Datatype | Property name | Property description | Default Value |
|---|---|---|---|
| Boolean | AddBookmarkForVisualGroup | Determines whether PDF exports of this Izenda.AdHoc.ReportSet will insert a bookmark at the beginning of each visual group. | False |
| Boolean | CanBeLoaded | Determines whether the Izenda.AdHoc.ReportSet can be loaded by checking every different condition in the validation process. | True |
| String | Category | Gets the report category. (deprecated) | null |
| Report | Chart | Gets or sets the Izenda.AdHoc.Report that is used as the standard chart on the Izenda.AdHoc.ReportSet. | null |
| Int32 | ColumnsCount | 2 | |
| Int32 | ColumnsInPivotGroup | Gets or sets the number of pivot columns that will be displayed on exports per page. | 0 |
| IEnumerable | CommonParameterFilters | Gets a list of all the distinct Izenda.AdHoc.Database.Columns used by all filters on the Izenda.AdHoc.ReportSet and on individual Izenda.AdHoc.Reports within it. | null |
| Boolean | CsvOnly | Determines whether this report may only be exported to CSV. | False |
| String | CustomCss | Gets or sets the System.String representation of the report-specific CSS styling used on the report. | null |
| String | Database | String.Empty | |
| DateTime | DateCreated | Gets the System.DateTime representing the date and time the report was created. | null |
| DateTime | DateModified | Gets the System.DateTime representing the last date and time the report was modified. | null |
| String | Description | Gets or sets the description of the Izenda.AdHoc.ReportSet. | String.Empty |
| String | DescriptionJustification | Gets or sets the System.String representation of the page justification of the report description. | null |
| Report | Detail | Gets or sets the Izenda.AdHoc.Report that is used as the standard report. | null |
| Boolean | Distinct | Determines whether all reports in this report set will enforce a DISTINCT condition on results obtained. | True |
| String | DrillDownKey | String.Empty | |
| String | DrillDownKey2 | String.Empty | |
| DrillDownKeys | DrillDownKeys | Gets a collection of columns used to drilldown into a subreport linked to this Izenda.AdHoc.ReportSet. | null |
| Boolean | ExposeAsDatasource | Determines whether this report should be available as a datasource when using the virtual datasources feature. | False |
| Int32 | FieldValueColumnPairs | Gets or sets the amount Field|Value column pairs. | 2 |
| FilterCollection | Filters | null | |
| FilterValue | FilterValue | Gets or sets the Izenda.AdHoc.FilterValue that determines the number of filters required to view the report. | None |
| String | Footer | Gets or sets the System.String footer text for the report. | null |
| String | FooterJustification | Gets or sets the System.String representation of the page justification of the report footer. | null |
| String | Header | Gets or sets the System.String header text for the report. | null |
| String | HeaderImageJustification | Gets or sets the System.String representation of the page justification of the logo image shown in the header of the report. | null |
| String | HeaderJustification | Gets or sets the System.String representation of the page justification of the report header. | null |
| Boolean | IgnoreDdkValue1 | Determines whether the first drilldown key in the collection of keys will be ignored for subreport data filtering purposes. | False |
| Boolean | IsDashBoard | Determines whether the report is being used on a dashboard. | False |
| Boolean | IsLocked | Gets or sets a value indicating that only admins or the report creator can modify the report. The filters may not be changed on the report viewer. | False |
| Boolean | IsValid | Determines whether this Izenda.AdHoc.ReportSet contains errors and has at least one field in one of the contained Izenda.AdHoc.Report objects. | True |
| Report | Item | Gets or sets the individual Izenda.AdHoc.Report within this Izenda.AdHoc.ReportSet. | null |
| Int32 | ItemsPerPage | Gets or sets the number of rows displayed on each page in the Report Viewer. UsePaginationInWebView must be true for this to have an effect. | 10000 |
| Boolean | LandscapePrinting | Determines whether printing the Izenda.AdHoc.ReportSet will default to landscape printing. When false, portrait mode is used. | False |
| Report | Map | Gets or sets the Izenda.AdHoc.Report that is used for the map on the Izenda.AdHoc.ReportSet. | null |
| Boolean | MinimizeGridWidth | Determines whether the data grids on the Izenda.AdHoc.ReportSet will use as little space as possible. When false, the data grid will always stretch across the length of the screen. | True |
| Boolean | MissingParameters | False | |
| String | Name | Gets the report name. (deprecated) | null |
| String | Owner | Gets or sets the System.String representation of the owner of the report. | DefaultAdministrator |
| String[] | OwnerTenantID | Gets or sets the list of tenant IDs associated with the owner of this Izenda.AdHoc.ReportSet. | [] |
| Boolean | PageBreakAfterVisualGroups | Determines whether page breaks will be inserted after each visual group when exporting to PDF. | False |
| String | PageHeader | Gets or sets the System.String header text for the report. | null |
| String | ProcessedDescription | Gets the description of the Izenda.AdHoc.ReportSet with field references replaced with their respective values. | String.Empty |
| String | ProcessedFooter | Gets the footer of the Izenda.AdHoc.ReportSet with field references replaced with their respective values. | String.Empty |
| String | ProcessedHeader | Gets the header of the Izenda.AdHoc.ReportSet with field references replaced with their respective values. | String.Empty |
| String | ProcessedPageHeader | Gets the exported page header of the Izenda.AdHoc.ReportSet with field references replaced with their respective values. | String.Empty |
| String | ProcessedTitle | Gets the title of the Izenda.AdHoc.ReportSet with field references replaced with their respective values. | String.Empty |
| Boolean | ReadOnly | Gets or sets a value indicating whether report can be overriden. | False |
| String | Recipients | Gets or sets the email recipients for this Izenda.AdHoc.ReportSet separated by commas. | String.Empty |
| String | ReportCategory | Gets or set the report category. | null |
| String | ReportID | Gets or sets the GUID that is associated with the Izenda.AdHoc.ReportSet. | 29156098-0678-469e-a58a-a4bfcd528cb5 |
| String | ReportName | Gets or sets the report name. | null |
| StringCollection | ReportOrder | Gets or sets the rendering order for all Izenda.AdHoc.Report objects currently within the AdHoc.reportSet based on their computed absolute position. The report's X and Y position are considered when computing position. | {} |
| ReportCollection | Reports | Gets or sets the collection of individual Izenda.AdHoc.Report objects associated with this Izenda.AdHoc.ReportSet. | {} |
| ReportSetType | ReportSetType | Gets or sets the Izenda.AdHoc.ReportSetType that determines how the Izenda.AdHoc.ReportSet is processed for viewing on different sources. | ReportDesigner |
| Hashtable | ReportVisibility | Gets or sets the individual user and role level visibility settings for the Izenda.AdHoc.ReportSet. | null |
| ReportSetResults | Results | Gets or sets the loaded result data for this Izenda.AdHoc.ReportSet. | null |
| String | RowTitle | Gets or sets the title of the report. | String.Empty |
| Boolean | Shared | False | |
| Boolean | ShowDateTime | Determines whether the date and time of the export is displayed on PDF and HTML exports for this Izenda.AdHoc.ReportSet. | False |
| Boolean | ShowPageNumber | Determines whether the page number will be displayed on PDF and HTML exports for this Izenda.AdHoc.ReportSet. | False |
| Boolean | ShowVisualGroupLabels | Gets or sets whether field names should be shown in visual group header. (deprecated) | False |
| String | Source | Gets or sets the report source table. | String.Empty |
| String | SQL | Gets the combined SQL for each part of the Izenda.AdHoc.ReportSet using the set of Izenda.AdHoc.Report objects in the set. | String.Empty |
| AdHocStyle | Style | Gets common style related to all reports in current reportset. | null |
| Report | Summary | Gets or sets the Izenda.AdHoc.Report that is used as a summary of the Detail report. | null |
| String | Title | Gets or sets the title of the report. | String.Empty |
| String | TitleJustification | Gets or sets the System.String representation of the page justification of the report title. | null |
| Boolean | UsePaginationInWebView | Determines whether the Izenda.AdHoc.ReportSet will be displayed in pages when being viewed on the Report Viewer. | True |
| Int32 | Version | Gets the version number of the report. | 6 |
| Boolean | ViewOnly | Gets or sets a value indicating that only admins or the report creator can modify the report. Others can change the filters on the report viewer. | False |
| VisualGroupStyle | VisualGroupStyle | Gets or sets the style that this Izenda.AdHoc.ReportSet will use to visually group data. | CommaDelimited |
##Methods
###AddField(System.String,System.String,System.Boolean,System.Boolean,System.String,System.Int32,System.String) Adds a field to the list of fields on the Detail Izenda.AdHoc.Report.
Parameters:
- System.String fieldName - The fully-qualified column name of the database field that is being added to the report.
- System.String description - The description that the new field should have.
- System.Boolean isOrderByField - Determines whether the new field will be included in the ORDER BY clause. When true, the sort order will be set to ascending order.
- System.Boolean isGroupByField - Determines whether the new field will be included in hte GROUP BY clause.
- System.String aggregateFunction - The System.String representation of the aggregation function the field should have, if any.
- System.Int32 width - The width in pixels of the new field.
- System.String formatString - The replacement System.String that will be used to format the field data when it returns from the database.
###AddField(System.String,System.String) Adds a field to the list of fields on the Detail Izenda.AdHoc.Report.
Parameters:
- System.String tableName - The System.String name of the table that will be converted into an Izenda.AdHoc.Field.
- System.String fieldName - The System.String name of the column that will be converted into an Izenda.AdHoc.Field.
Returns:
The Izenda.AdHoc.Field that was generated from the input information and added to the Detail report.
###AddField(System.String) Adds a field to the list of fields on the Detail Izenda.AdHoc.Report.
Parameters:
- System.String fieldName - The System.String name of the column that will be converted into an Izenda.AdHoc.Field.
Returns:
The Izenda.AdHoc.Field that was generated from the input information and added to the Detail report.
###AddFieldToReport(Izenda.AdHoc.Report,System.String,System.String,System.Boolean,System.Boolean,System.String,System.Int32,System.String) Adds a field to the list of fields on the specified Izenda.AdHoc.Report.
Parameters:
- Izenda.AdHoc.Report r - The Izenda.AdHoc.Report to add the field to.
- System.String fieldName - The fully-qualified column name of the database field that is being added to the report.
- System.String description - The description that the new field should have.
- System.Boolean isOrderByField - Determines whether the new field will be included in the ORDER BY clause. When true, the sort order will be set to ascending order.
- System.Boolean isGroupByField - Determines whether the new field will be included in hte GROUP BY clause.
- System.String aggregateFunction - The System.String representation of the aggregation function the field should have, if any.
- System.Int32 width - The width in pixels of the new field.
- System.String formatString - The replacement System.String that will be used to format the field data when it returns from the database.
Returns:
The Izenda.AdHoc.Field that was added to the specified report.
###AddFilter(System.String) Adds a new Izenda.AdHoc.Filter to the report that is hidden from the AdHocReportDesigner and Report Viewer.
Parameters:
- System.String fieldName - The fully-qualified column name of the database field that the data will filter on.
Returns:
The Izenda.AdHoc.Filter that was added to the Izenda.AdHoc.ReportSet.
###AddFilter(System.String,System.Object) Adds a new Izenda.AdHoc.Filter to the report that is visible on the AdHocReportDesigner.
Parameters:
- System.String fieldName - The fully-qualified column name of the database field that the data will filter on.
- System.Object value - The filter value that will be used.
Returns:
The Izenda.AdHoc.Filter that was added to the Izenda.AdHoc.ReportSet.
###AddFilter(System.String,System.Boolean) Adds a new Izenda.AdHoc.Filter to the report that is visible on the AdHocReportDesigner. The operator the new filter will use is defaulted to True.
Parameters:
- System.String fieldName - The fully-qualified column name of the database field that the data will filter on.
- System.Boolean value - Whether or not the new filter will use a NOT condition.
###AddFilter(System.String,Izenda.AdHoc.OperatorTypes,System.Boolean,System.Object) Adds a new Izenda.AdHoc.Filter to the report that is visible on the AdHocReportDesigner.
Parameters:
- System.String fieldName - The fully-qualified column name of the database field that the data will filter on.
- Izenda.AdHoc.OperatorTypes operatorType - The type of operator the filter will use.
- System.Boolean not - Whether the NOT keyword will be used in the query generated by the filter.
- System.Object value - The filter value that will be used.
###AddFilter(System.String,Izenda.AdHoc.OperatorTypes,System.Boolean,System.Boolean,System.Object[]) Adds a new Izenda.AdHoc.Filter to the report that is visible on the AdHocReportDesigner.
Parameters:
- System.String fieldName - The fully-qualified column name of the database field that the data will filter on.
- Izenda.AdHoc.OperatorTypes operatorType - The type of operator the filter will use.
- System.Boolean orIsBlank - Whether the filter will accept nulls as valid data for the filter.
- System.Boolean isParameter
- System.Object[] values - The list of filter values that will be used.
###AddHiddenFilter(System.String,System.Object) Adds a new Izenda.AdHoc.Filter to the report that is hidden from the AdHocReportDesigner and Report Viewer.
Parameters:
- System.String fieldName - The fully-qualified column name of the database field that the data will filter on.
- System.Object value - The filter value that will be used.
Returns:
The Izenda.AdHoc.Filter that was added to the Izenda.AdHoc.ReportSet.
###AddSource(System.String) Adds a table with the specified name to the list of JoinedTables with no joining information.
Parameters:
- System.String sourceTableName - The Syste.String representation of the name of the table to add.
###AddSource(System.String,System.String,System.String,System.String,Izenda.AdHoc.JoinType) Adds a table with the specified information to the list of JoinedTables.
Parameters:
- System.String sourceTableName - The Syste.String representation of the name of the table to add.
- System.String fieldName - The System.String fully-qualified column name of the lefthand join relationship.
- System.String joinFieldName - The System.String fully-qualified column name of the righthand join relationship.
- System.String foreignTableName - The Syste.String representation of the name of the righthand table to join on.
- Izenda.AdHoc.JoinType joinType - The Izenda.AdHoc.JoinType that will be used to determine what kind of join to use.
###AddSummaryField(System.String,System.String) Adds a field to the list of fields on the Summary Izenda.AdHoc.Report.
Parameters:
- System.String tableName - The System.String name of the table that will be converted into an Izenda.AdHoc.Field.
- System.String fieldName - The System.String name of the column that will be converted into an Izenda.AdHoc.Field.
Returns:
The Izenda.AdHoc.Field that was generated from the input information and added to the Detail report.
###AddSummaryField(System.String) Adds a field to the list of fields on the Summary Izenda.AdHoc.Report.
Parameters:
- System.String fieldName - The System.String name of the column that will be converted into an Izenda.AdHoc.Field.
###AddSummaryField(System.String,System.String,System.Boolean,System.Boolean,System.String,System.Int32,System.String) Adds a field to the list of fields on the Summary Izenda.AdHoc.Report.
Parameters:
- System.String fieldName - The fully-qualified column name of the database field that is being added to the report.
- System.String description - The description that the new field should have.
- System.Boolean isOrderByField - Determines whether the new field will be included in the ORDER BY clause. When true, the sort order will be set to ascending order.
- System.Boolean isGroupByField - Determines whether the new field will be included in hte GROUP BY clause.
- System.String aggregateFunction - The System.String representation of the aggregation function the field should have, if any.
- System.Int32 width - The width in pixels of the new field.
- System.String formatString - The replacement System.String that will be used to format the field data when it returns from the database.
###Equals(System.Object) Determines whether the specified System.Object is equal to the current System.Object.
Parameters:
- System.Object obj - The System.Object to compare with the current System.Object.
Returns:
true if the specified System.Object is equal to the current System.Object; otherwise, false.
###GenerateOutput(System.String) Creates a serialized output file of the Izenda.AdHoc.ReportSet using the specified output type.
Parameters:
- System.String type - The type of file to export to.
Returns:
A serialized System.Byte array containing the serialized data of the output file.
###GetColumnNameArray(System.String) Gets the individual parts of a column name using the full name of a column.
Parameters:
- System.String fullName - The fully qualified name of the column.
Returns:
The System.String array of the individual parts of the fully qualified column name.
###GetHashCode() Serves as a hash function for a particular type.
Returns:
A hash code for the current System.Object.
###GetQualifiedName(System.String) Gets the fully qualified column name from an arbitrary representation of the column name.
Parameters:
- System.String columnName - The source column name.
Returns:
The fully qualified System.String representation of the column name.
###GetSchema() Gets the XML schema.
Returns:
XML schema of this object.
###GetType() Gets the System.Type of the current instance.
Returns:
The System.Type instance that represents the exact runtime type of the current instance.
###GetVolatileOption(System.String) Gets the System.Object with the specified System.String key from a collection of dynamic properties associated with the Izenda.AdHoc.ReportSet.
Parameters:
- System.String key - The System.String key of the dynamic property to get the value of.
Returns:
A System.Object representation of the dynamic property.
###InitializeNew() Initializes a new instance of a Izenda.AdHoc.ReportSet with the source table set to the DefaultTable.
Returns:
A new Izenda.AdHoc.ReportSet with the source table set.
###LoadData(Izenda.AdHoc.ReportOutputOptions) Loads the Izenda.AdHoc.ReportSetResults containing the data for the report.
Parameters:
- Izenda.AdHoc.ReportOutputOptions options - The various rendering options that deterimine how the data should be loaded.
Returns:
The loaded Izenda.AdHoc.ReportSetResults containing the report data.
###ReadXml(System.Xml.XmlReader) Reads XML data into the Izenda.AdHoc.ReportSet using the specified System.Xml.XmlReader.
Parameters:
- System.Xml.XmlReader reader - The System.Xml.XmlReader from which to read.
###ReadXml(System.String,Izenda.AdHoc.ReportListAuxData)
Parameters:
- System.String xml
- Izenda.AdHoc.ReportListAuxData auxData
###ReadXml(System.String) Reads XML data into the Izenda.AdHoc.ReportSet from the specified System.String.
Parameters:
- System.String xml - The System.String from which to read.
###RemoveVolatileOption(System.String) Removes the dynamic property with the specified key from the collection on the Izenda.AdHoc.ReportSet.
Parameters:
- System.String key - The System.String key to locate in the collection.
###RenderHtml() Generates the body of the HTML report using the loaded data in the report.
Returns:
A HTML System.String containing the markup for the report including style information.
###SetAllFilterParameters(System.Boolean) Iterates through every filter on the Izenda.AdHoc.ReportSet and sets the value determining whether they will be displayed on the Report Viewer to the specified value.
Parameters:
- System.Boolean b - Whether each Izenda.AdHoc.Filter in the Izenda.AdHoc.ReportSet will be displayed on the Report Viewer.
###SetVolatileOption(System.String,System.Object) Sets the System.Object representing a dynamic property in the collection of properties associated with the Izenda.AdHoc.ReportSet.
Parameters:
- System.String key - The System.String key used to identify the dynamic property.
- System.Object value - The System.Object representation of the dynamic property to set on the Izenda.AdHoc.ReportSet.
###ToString() Returns a System.String that represents the current System.Object.
Returns:
A System.String that represents the current System.Object.
###WriteRdl(System.Xml.XmlWriter) Writes the generated RDL output for the Izenda.AdHoc.ReportSet to the input System.Xml.XmlWriter.
Parameters:
- System.Xml.XmlWriter writer - The System.Xml.XmlWriter to write the RDL output to.
###WriteRdl()
###WriteRdlOld(System.Xml.XmlWriter)
Parameters:
- System.Xml.XmlWriter writer
###WriteXml() Writes the current data of the Izenda.AdHoc.ReportSet to the specified System.String and returns it.
Returns:
The XML formatted System.String for the report set.
###WriteXml(System.Xml.XmlWriter) Writes the current data of the Izenda.AdHoc.ReportSet to the specified XmlWriter.
Parameters:
- System.Xml.XmlWriter writer - The System.Xml.XmlWriter with which to write.
###WriteXmlWithoutAnyChanges(System.Boolean,System.Boolean) Forces the Izenda.AdHoc.ReportSet to be written to the output System.String.
Parameters:
- System.Boolean updateDateTime - Determines whether the generated XML will use the current time as the last modified date.
- System.Boolean saveHiddenFilters - Determines whether the generated XML will include hidden filters in addition to regular filters.
Returns:
The System.String representation of the generated Izenda.AdHoc.ReportSet XML.