#Field
##Properties
| Datatype | Property name | Property description | Default Value |
|---|---|---|---|
| IAggregateFunction | AggregateFunction | Gets the Izenda.AdHoc.IAggregateFunction for the current field. | null |
| String | AliasTable | null | |
| String | CalcDescription | Gets or sets the field description that is appended to calculated fields for use in dropdown menus where calculated fields can be selected. | null |
| String | ClearDescription | Gets the field's description without grouping or parameter information. | null |
| String | Coefficient | null | |
| Boolean | CoeffWithDivision | Determines whether this field requires a special formatter to handle division. | null |
| String | ColumnGroup | Gets or sets the column grouping that this field will appear under when the report is rendered. All adjacent fields sharing the same column group will be grouped together. | null |
| String | ColumnName | Gets or sets the column name of this field. | null |
| Column | DbColumn | Gets the backing Izenda.AdHoc.Database.Column behind the field. | null |
| String | Description | Gets or sets the field's description. | null |
| String | DescriptionAsSqlName | Gets the SQL formatted System.String representation of the field's description. | null |
| String | DescriptionAsSqlNameBySafetyDescription | Gets a System.String representation of the field's description that will be formatted to be acceptible as a database identifier. | null |
| String | DescriptionID | null | |
| String | DrillDownStyle | Gets or sets the drill-down style that is applied to the field from a list of registered drill-down styles. | null |
| String | ExpressionType | null | |
| Boolean | ExtraField | Gets or sets whether this field is an extra field generated by an expression or pivot. | null |
| FieldHighlightInfo | GaugeColor | Gets or sets the Izenda.AdHoc.FieldHighlightInfo that is used to determine the color gauges will be that are used with this field. | null |
| Double | GaugeMax | Gets or sets the maximum value for the dashboard gauge format when it is being used by the field. | null |
| Double | GaugeMin | Gets or sets the minimum value for the dashboard gauge format when it is being used by the field. | null |
| String | GaugeStyle | Gets or sets the style of gauge that will be used on the field, if any. | null |
| Boolean | GroupByExpression | Determines whether to add the whole Expression to the GROUP BY clause | null |
| String | GUID | Gets or sets the unique identifier for this AdHoc.Database.Field. | null |
| FieldHighlightInfo | Highlight | null | |
| Boolean | IsLabel | Gets a value indicating whether this field is label. | null |
| Boolean | IsMultilineHeader | Gets or sets whether the field's header will display as single-line or mult-line. | null |
| Boolean | PageBreak | Determines whether this field will cause a page break to be inserted when exporting the report to PDF or Microsoft Word. | null |
| String | SqlName | Gets the SQL formatted database column name associated with this field. | null |
| String | SqlSafetyDescription | Gets converted Description for safety usage in SQL scripts. | null |
| String | SubtotalExpression | null | |
| String | SubtotalFunction | Gets or sets the function used for generating subtotals for this field from the list of functions that can be applied to subtotals. | null |
| String | TargetReport | Gets or sets the name of the report that will be used as the target of the drilldown if this field has enabled the drilldown feature. | null |
| FieldHighlightInfo | TextHighlight | Gets or sets the Izenda.AdHoc.FieldHighlightInfo that is used to highlight the text of the field. | null |
| String | Url | Gets or sets a URL that will be used as a hyperlink on the field. | null |
| FieldRangeValueInfo | ValueRanges | Gets or sets the Izenda.AdHoc.FieldRangeValueInfo that is used to substitute ranges of specific values with a more generic one. | null |
| Unit | Width | Gets or sets the width of the field. | null |
##Methods
###Abbreviate(System.Boolean,System.Boolean) Abbreviates field. (deprecated)
Parameters:
- System.Boolean abCol - If True then title is abbreviated.
- System.Boolean abData - If True then data is abbreviated.
###Clone() Creates a new object that is a copy of the current object.
Returns:
A new object that is a copy of this object.
###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.
###GetHashCode() Serves as a hash function for a particular type.
Returns:
A hash code for the current System.Object.
###GetSchema() Gets the XML schema.
Returns:
XML schema of this object.
###GetSQL(System.Boolean,Izenda.AdHoc.IAggregateFunction) Gets the SQL statement for the current AdHoc.Database.Field accounting for whether totals are present and the function used to generate the totals.
Parameters:
- System.Boolean grandTotalCommand - Determines whether the generated SQL will be for a grand total or a regular query.
- Izenda.AdHoc.IAggregateFunction totalFunction - The Izenda.AdHoc.IAggregateFunction that will be used to generate a grand total expression for the field.
Returns:
The System.String representation of the SQL expression for this AdHoc.Database.Field.
###GetSQL(System.Boolean,Izenda.AdHoc.IAggregateFunction,System.Boolean) Gets the SQL statement for the current AdHoc.Database.Field accounting for whether totals are present and the function used to generate the totals.
Parameters:
- System.Boolean grandTotalCommand - Determines whether the generated SQL will be for a grand total or a regular query.
- Izenda.AdHoc.IAggregateFunction totalFunction - The Izenda.AdHoc.IAggregateFunction that will be used to generate a grand total expression for the field.
- System.Boolean addAlias - Determines whether to use an AS statement with the AdHoc.Database.Field's alias.
Returns:
The System.String representation of the SQL expression for this AdHoc.Database.Field.
###GetSQL(System.Boolean,Izenda.AdHoc.IAggregateFunction,System.Boolean,System.Boolean) Gets the SQL statement for the current AdHoc.Database.Field accounting for whether totals are present and the function used to generate the totals.
Parameters:
- System.Boolean grandTotalCommand - Determines whether the generated SQL will be for a grand total or a regular query.
- Izenda.AdHoc.IAggregateFunction totalFunction - The Izenda.AdHoc.IAggregateFunction that will be used to generate a grand total expression for the field.
- System.Boolean addAlias - Determines whether to use an AS statement with the AdHoc.Database.Field's alias.
- System.Boolean forGroup - Determines whether the SQL statement generated will use special field formatting for a GROUP BY.
Returns:
The System.String representation of the SQL expression for this AdHoc.Database.Field.
###GetSQL(System.Boolean,Izenda.AdHoc.IAggregateFunction,System.Boolean,System.Boolean,System.Boolean) Gets the SQL statement for the current AdHoc.Database.Field accounting for whether totals are present and the function used to generate the totals.
Parameters:
- System.Boolean grandTotalCommand - Determines whether the generated SQL will be for a grand total or a regular query.
- Izenda.AdHoc.IAggregateFunction totalFunction - The Izenda.AdHoc.IAggregateFunction that will be used to generate a grand total expression for the field.
- System.Boolean addAlias - Determines whether to use an AS statement with the AdHoc.Database.Field's alias.
- System.Boolean forGroup - Determines whether the SQL statement generated will use special field formatting for a GROUP BY.
- System.Boolean forOrder - Determines whether the SQL statement generated will use special field formatting for an ORDER BY.
Returns:
The System.String representation of the SQL expression for this AdHoc.Database.Field.
###GetSQL(System.Boolean,Izenda.AdHoc.IAggregateFunction,System.Boolean,System.Boolean,System.Boolean,System.Boolean) Gets the SQL statement for the current AdHoc.Database.Field accounting for whether totals are present and the function used to generate the totals.
Parameters:
- System.Boolean grandTotalCommand - Determines whether the generated SQL will be for a grand total or a regular query.
- Izenda.AdHoc.IAggregateFunction totalFunction - The Izenda.AdHoc.IAggregateFunction that will be used to generate a grand total expression for the field.
- System.Boolean addAlias - Determines whether to use an AS statement with the AdHoc.Database.Field's alias.
- System.Boolean forGroup - Determines whether the SQL statement generated will use special field formatting for a GROUP BY.
- System.Boolean forOrder - Determines whether the SQL statement generated will use special field formatting for an ORDER BY.
- System.Boolean forTotal - Determines whether the SQL statement generated will use special field formatting for generating totals.
Returns:
The System.String representation of the SQL expression for this AdHoc.Database.Field.
###GetSQL(System.Boolean,Izenda.AdHoc.IAggregateFunction,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.String) Gets the SQL statement for the current AdHoc.Database.Field accounting for whether totals are present and the function used to generate the totals.
Parameters:
- System.Boolean grandTotalCommand - Determines whether the generated SQL will be for a grand total or a regular query.
- Izenda.AdHoc.IAggregateFunction totalFunction - The Izenda.AdHoc.IAggregateFunction that will be used to generate a grand total expression for the field.
- System.Boolean addAlias - Determines whether to use an AS statement with the AdHoc.Database.Field's alias.
- System.Boolean forGroup - Determines whether the SQL statement generated will use special field formatting for a GROUP BY.
- System.Boolean forOrder - Determines whether the SQL statement generated will use special field formatting for an ORDER BY.
- System.Boolean forTotal - Determines whether the SQL statement generated will use special field formatting for generating totals.
- System.String additionalName - Additional identifier information for the field that is appended to the SQL.
Returns:
The System.String representation of the SQL expression for this AdHoc.Database.Field.
###GetSQL(System.Boolean,Izenda.AdHoc.IAggregateFunction,System.Boolean,System.Boolean,System.Boolean,System.Boolean,System.String,System.Boolean) Gets the SQL statement for the current AdHoc.Database.Field accounting for whether totals are present and the function used to generate the totals.
Parameters:
- System.Boolean grandTotalCommand - Determines whether the generated SQL will be for a grand total or a regular query.
- Izenda.AdHoc.IAggregateFunction totalFunction - The Izenda.AdHoc.IAggregateFunction that will be used to generate a grand total expression for the field.
- System.Boolean addAlias - Determines whether to use an AS statement with the AdHoc.Database.Field's alias.
- System.Boolean forGroup - Determines whether the SQL statement generated will use special field formatting for a GROUP BY.
- System.Boolean forOrder - Determines whether the SQL statement generated will use special field formatting for an ORDER BY.
- System.Boolean forTotal - Determines whether the SQL statement generated will use special field formatting for generating totals.
- System.String additionalName - Additional identifier information for the field that is appended to the SQL.
- System.Boolean forDundasMap - Determines whether the aggregate function list used will use the standard aggregate function list or the Dundas aggregate function list.
Returns:
The System.String representation of the SQL expression for this AdHoc.Database.Field.
###GetSqlName() Gets the SQL formatted database column name associated with this field.
###GetType() Gets the System.Type of the current instance.
Returns:
The System.Type instance that represents the exact runtime type of the current instance.
###ReadXml(System.Xml.XmlReader) Reads XML data into the Izenda.AdHoc.Field using the specified System.Xml.XmlReader.
Parameters:
- System.Xml.XmlReader reader - The System.Xml.XmlReader from which to read.
###ReadXml(System.String) Reads XML data into the Izenda.AdHoc.Field from the specified System.String.
Parameters:
- System.String xml - The System.String from which to read.
###ToString() Gets the System.String representation of the field.
Returns:
The name of the column the field is based on.
###WriteXml() Writes the current data of the Izenda.AdHoc.Field to the specified System.String and returns it.
Returns:
The writed System.String.
###WriteXml(System.Xml.XmlWriter) Writes the current data of the Izenda.AdHoc.Field to the specified XmlWriter.
Parameters:
- System.Xml.XmlWriter writer - The System.Xml.XmlWriter with which to write.