Report |
A ReportRestriction defines a restriction applied to a report model. A report restriction is a child of a ReportElement.
Inheritance HierarchySystemObject
Seal.ModelRootEditor
Seal.ModelRootComponent
Seal.ModelMetaColumn
Seal.ModelReportElement
Seal.ModelReportRestriction
Seal.ModelRootEditor
Seal.ModelRootComponent
Seal.ModelMetaColumn
Seal.ModelReportElement
Seal.ModelReportRestriction
Namespace: Seal.Model
Assembly: SealLibrary (in SealLibrary.dll) Version: 8.0.0.0+c5a14bc14715399f60fcf611201a5e8ad953fbc3
SyntaxC#
public class ReportRestriction : ReportElement
The ReportRestriction type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ReportRestriction | Initializes a new instance of the ReportRestriction class |
Properties| Name | Description | |
|---|---|---|
 | AggregateFunction |
Aggregate function applied to the Data element
(Inherited from ReportElement) |
| AllowAPI | If True, the restriction can be modified through the Web API, even if the restriction is not prompted. |
| AllowedDisplayOperators | List of operators to display |
| AllowedOperators | List of allowed operators for this restriction |
| AxisUseValues |
For Numeric or Date Time axis, if true, the element values are used for the axis, otherwise axis values are linear. This feature does not work for all types of chart.
(Inherited from ReportElement) |
| CalculationOption |
For numeric Data elements, define calculation option applied on the element in the table
(Inherited from ReportElement) |
| CaseSensitive | If True, the restriction text is case sensitive in the LINQ where clause. |
| Category |
Category used to display the column in the Report Designer tree view. Category hierarchy can be defined using the '/' character (e.g. 'Master/Name1/Name2').
(Inherited from MetaColumn) |
| CellScript |
If not empty, the script is executed to calculate custom cell value and CSS
(Inherited from ReportElement) |
| ChartJSSerie |
Definition of the serie for the element in the Chart JS chart
(Inherited from ReportElement) |
| ColumnName |
Returns the SQL column name without prefix
(Inherited from MetaColumn) |
| ContainsHtml |
If True, the value contains HTML tags.
(Inherited from ReportElement) |
| CssClass |
CSS Classes applied to the cell values of the result HTML Table. Bootstrap classes may be used.
(Inherited from MetaColumn) |
| CssClassEl |
CSS Classes applied to the cell values of the result HTML Table. Bootstrap classes may be used.
(Inherited from ReportElement) |
| CssStyle |
CSS Styles applied to the cell values of the result HTML Table. Bootstrap classes may be used.
(Inherited from MetaColumn) |
| CssStyleEl |
CSS Styles applied to the cell values of the result HTML Table.
(Inherited from ReportElement) |
| CssTitle |
If True, the CSS Styles and Classes are also applied to the cell titles.
(Inherited from ReportElement) |
| Date1 | Value used for the restriction (DateTime) |
| Date1Keyword | Date1 Keyword value |
| Date2 | Second value used for the restriction (DateTime) |
| Date2Keyword | Date2 Keyword value |
| Date3 | Third value used for the restriction (DateTime) |
| Date3Keyword | Date3 Keyword value |
| Date4 | Fourth value used for the restriction (DateTime) |
| Date4Keyword | Date4 Keyword value |
| DateTimeStandardFormat |
Standard display format applied to the element
(Inherited from MetaColumn) |
| DateTimeStandardFormatRe | Standard display format applied to the restriction display value |
| DisplayName |
Name used to display the column in the Report Designer tree view and in the report results
(Inherited from MetaColumn) |
| DisplayName2 |
Display name used to sort the TreeView
(Inherited from MetaColumn) |
| DisplayNameEl |
Name of the element when displayed in result tables or restrictions
(Inherited from ReportElement) |
| DisplayNameElTranslated |
Name of the element translated
(Inherited from ReportElement) |
| DisplayNameWithModel |
Name of the element with the model name
(Inherited from ReportElement) |
| DisplayOrder |
The order number used to sort the column in the tree view (by table and by category)
(Inherited from MetaColumn) |
| DisplayOrderRE | Sort order used for the display of the prompted restrictions when the report is executed. |
| DisplayRestriction | Display text of the restriction (value only) |
| DisplayRestrictionForEditor | Display text of the restriction (for editor) |
| DisplayText | Display text of the full restriction (label and value) |
| DisplayValue1 | Final display value 1 |
| DisplayValue2 | Final display value 2 |
| DisplayValue3 | Final display value 3 |
| DisplayValue4 | Final display value 4 |
| DoubleValue | Value as a double? |
| DrillChildren |
Defines the child columns to navigate from this column with the drill feature
(Inherited from MetaColumn) |
| DrillUpOnlyIfDD |
If true, Drill Up is activated only if a drill down occured
(Inherited from MetaColumn) |
| EmptyRepeated |
IIf true, column values are not repeated if they have the same values.
(Inherited from ReportElement) |
| Enum |
Enumerated list if the column has an EnumGUID
(Inherited from MetaColumn) |
| EnumDisplayValue | String containing all the enumerated values with their display labels |
| EnumEL |
Final enumerated list of the element
(Inherited from ReportElement) |
| EnumGUID |
If defined, a list of values is proposed when the column is used for restrictions
(Inherited from MetaColumn) |
| EnumGUIDEL |
If defined, the enumerated list is used for the display and for sorting
(Inherited from ReportElement) |
| EnumGUIDRE | If defined, the restriction values are selected using the enumerated list |
| EnumLayout | Layout of the restriction for the values of the enumerated list: Either a select list or buttons (for a small number of values). |
| EnumLINQValue | String containing the LINQ values of the enum values |
| EnumRE | The final enumerated list of the restriction |
| EnumSQLValue | String containing the SQL values of the enum values |
| EnumValue | Helper to edit the enumerated values |
| EnumValues | Enumerated values for the restriction |
| Error |
Last error message
(Inherited from MetaColumn) |
| FinalCssClass |
CSS Classes applied to the cell values of the result HTML Table.
(Inherited from ReportElement) |
| FinalCssStyle |
CSS Style applied to the cell values of the result HTML Table.
(Inherited from ReportElement) |
| FinalDate1 | Final Date Time value 1 |
| FinalDate2 | Final Date Time value 2 |
| FinalDate3 | Final Date Time value 3 |
| FinalDate4 | Final Date Time value 4 |
| FinalSort |
Final sort as integer (without ASC or DESC)
(Inherited from ReportElement) |
| FinalSortOrder |
Final sort order of the element
(Inherited from ReportElement) |
| FirstDateValue | First Date Time value |
| FirstNumericValue | First numeric value |
| FirstSelection | If set, the values are selected for the first report execution: All values, first or last value. This may be used for dynamic list. |
| FirstStringValue | First string value |
| FirstValue | First restriction value |
| ForceAggregate |
If Yes, it indicates that the element is an aggregate even it is set in a dimension (Page/Row/Column). By default, the metacolumn flag 'Is aggregate' is used. This flag impacts the build of the GROUP BY Clause.
(Inherited from ReportElement) |
| Format |
If not empty, specify the format of the elements values displayed in the result tables (.Net Format Strings)
(Inherited from MetaColumn) |
| FormatEl |
Final format of the element
(Inherited from ReportElement) |
| FormatRe | If not empty, specify the format of the restriction display values (.Net Format Strings) |
| FullDisplayName |
Full display name
(Inherited from MetaColumn) |
| GUID |
The unique identifier
(Inherited from RootComponent) |
| HasTime |
True if the column is a DateTime displaying time
(Inherited from MetaColumn) |
| HasTimeEl |
True is the element has a time format
(Inherited from ReportElement) |
| HasTimeRe | True if the restriction has time |
| HasValue | True if the restriction has a value |
| HasValue1 | True if the restriction has a value 1 |
| HasValue2 | True if the restriction has a value 2 |
| HasValue3 | True if the restriction has a value 3 |
| HasValue4 | True if the restriction has a value 4 |
| HelperAddSubReport |
Editor Helper: Add an existing Sub-Report to this column
(Inherited from MetaColumn) |
| HelperCheckColumn |
Editor Helper: Check the column SQL statement in the database
(Inherited from MetaColumn) |
| HelperCreateDrillDates |
Editor Helper: Create automatically a 'Year' column and a 'Month' column to drill down to the date
(Inherited from MetaColumn) |
| HelperCreateEnum |
Editor Helper: Click to create an enumerated list from this table column
(Inherited from MetaColumn) |
| HelperCreateSubReport |
Editor Helper: Create a Sub-Report to display the detail of this table
(Inherited from MetaColumn) |
| HelperOpenSubReportFolder |
Editor Helper: Open the Sub-Report folder in Windows Explorer
(Inherited from MetaColumn) |
| HelperShowValues |
Editor Helper: Show the first 1000 values of the column
(Inherited from MetaColumn) |
| HtmlIndex | Helper to build the HTML index |
| Information |
Last information message ther column has been checked
(Inherited from MetaColumn) |
| InputDateFormat | Input date time format for the restriction |
| InputRows | If greater than 0, specifies the number of lines available to edit the first restriction value (only valid for text or numeric when the restriction is prompted) |
| InputRows1 | Number of lines for the first input |
| InsertPosition |
The position in Page, Row, Column, Data of the element inserted if the model is used as a reference model. A value of 0 means to add the element at the end. A negative value can be specified to indicate the position from the last element (e.g. -1 means the position before the last element).
(Inherited from ReportElement) |
| IsAggregate |
Must be True if the column contains SQL aggregate functions like SUM,MIN,MAX,COUNT,AVG
(Inherited from MetaColumn) |
| IsAggregateEl |
True if the element definition contains already the aggregate
(Inherited from ReportElement) |
| IsBetweenOperator | True is the operator is Between (or Not) |
| IsCommonRestrictionValue |
True is the element is a common restriction
(Inherited from ReportElement) |
| IsContainAllAnyOperator | True is the operator is Contain All or Any |
| IsContainOperator | True is the operator is Contain (or Not),Starts, Ends |
| IsCount |
True if the element has a Count or Count Distinct aggregate
(Inherited from ReportElement) |
| IsDateTime |
True if the element is for Date Time values
(Inherited from ReportElement) |
| IsEnum |
True if the element has an enumerated list
(Inherited from ReportElement) |
| IsEnumRE | True is the restriction is an enumerated list |
| IsGreaterSmallerOperator | True is the operator is Greater or Smaller |
| IsInputValue | True if the restriction is an input value |
| IsNoSQL | True if the source is No SQL |
| IsNotAggregate |
True is the lement is not an aggregate
(Inherited from ReportElement) |
| IsNumeric |
True if the element is for numeric values
(Inherited from ReportElement) |
| IsSerie |
True is the element defines a Serie
(Inherited from ReportElement) |
| IsSorted |
True if the element is sorted
(Inherited from ReportElement) |
| IsSQL |
True if the source is a standard SQL source
(Inherited from MetaColumn) |
| IsText |
True if the element is for text values
(Inherited from ReportElement) |
| LINQColumnName |
LINQ Select Column name of the element
(Inherited from ReportElement) |
| LINQSelectColumnName |
LINQ Select Column name of the element
(Inherited from ReportElement) |
| LINQText | LINQ of the restriction |
| MetaColumn |
The MetaColumn of the element
(Inherited from ReportElement) |
| MetaColumnGUID |
GUID of the MetaColumn of the element
(Inherited from ReportElement) |
| MetaEnumValuesEL |
List of values of the element enum
(Inherited from ReportElement) |
| MetaEnumValuesRE | List of values of the restriction enum |
| MetaTable |
Current MetaTable of the column
(Inherited from MetaColumn) |
| Model |
Current model
(Inherited from ReportElement) |
| MongoText | LINQ of the restriction |
| Name |
The name of the column in the table or the SQL Statement used for the column
(Inherited from MetaColumn) |
| NavigationScript |
Optional Razor Script executed if script navigation links have been added in the CellScript
(Inherited from ReportElement) |
| NumericStandardFormat |
Standard display format applied to the element
(Inherited from MetaColumn) |
| NumericStandardFormatRe | Standard display format applied to the restriction display value |
| Nvd3Serie |
Definition of the serie for the element in the NVD3 chart
(Inherited from ReportElement) |
| Operator | The Operator used for the restriction. If Value Only is selected, the restriction is replaced by the value only (with no column name and operator). |
| OperatorHtmlId | Html identifier for the restriction operator |
| OperatorLabel | If not empty, overwrite the operator display text |
| OperatorStyle | How the element name and restriction operator is displayed or not. |
| OptionHtmlId | Html identifier for the restriction option (for enumerated list) |
| OptionValueHtmlId | Html identifier for the restriction option value (for enumerated list) |
| Pattern | Return the pattern text for the restriction |
| PivotPosition |
Position of the element in the Cross Table: Row, Column, Page or Data
(Inherited from ReportElement) |
| PlaceHolder | Short hint that describes the expected value of the input field. |
| PlotlySerie |
Definition of the serie for the element in the Plotly chart
(Inherited from ReportElement) |
| Prompt | Define if the value of the restriction is prompted to the user when the report is executed |
| PromptedEnumValues | List of prompted enum values |
| RawDisplayName |
Display name of the MetaColumn
(Inherited from ReportElement) |
| RawLINQColumnName |
LINQ Select Column name of the element
(Inherited from ReportElement) |
| RawSQLColumn |
SQL of the MetaColumn
(Inherited from ReportElement) |
| Report |
Current report
(Inherited from ReportElement) |
| Required | If true and the restriction is prompted, a value is required to execute the report |
| ScottPlotSerie |
Definition of the serie for the element in the Chart JS chart
(Inherited from ReportElement) |
| SerieDefinition |
Defines how the element is used in the chart. Row or Column elements can be either Axis or Splitter (to create a serie for each splitter value).
(Inherited from ReportElement) |
| SerieSortOrder |
Defines if the serie is sorted ascending or descending in the chart
(Inherited from ReportElement) |
| SerieSortType |
Defines how the serie is sorted in the chart
(Inherited from ReportElement) |
| SetNullToZero |
If Yes, empty cells are set to 0.
(Inherited from ReportElement) |
| ShowAllEnums |
If Yes, all the values defined in the enumerated list will be shown in the tables, even if the value is not the database Result Set.
(Inherited from ReportElement) |
| ShowName | Control of the OperatorStyle dedicated for Input Values or Common Restrictions |
| ShowSubTotals |
If true, a line showing sub-totals is added to the main data table when the value of the element changes
(Inherited from ReportElement) |
| ShowTotal |
For Data elements, add a row or a column showing the total of the element in the table. 'Show only total' means that the columns containing the values of the element will be hidden in the table, only the column containing the total of the element is displayed.
(Inherited from ReportElement) |
| SortOrder |
Sort order in the result tables. Page elements are sorted first, then Row, Column and Data elements.
(Inherited from ReportElement) |
| Source |
Current MetaSource
(Inherited from MetaColumn) |
| SQL | If not empty, overwrite the default SQL used for the restriction in the WHERE clause |
| SQLColumn |
Final SQL of the element
(Inherited from ReportElement) |
| SQLColumnName |
SQL Column name of the element
(Inherited from ReportElement) |
| SQLText | SQL of the restriction |
| SubReports |
Defines sub-reports to navigate from this column
(Inherited from MetaColumn) |
| Tag |
Tag used to define the security of the Web Report Designer (Columns of the Security Groups defined in the Web Security)
(Inherited from MetaColumn) |
| TotalAggregateFunction |
Aggregate function applied for the totals
(Inherited from ReportElement) |
| TriggerExecution | If set, the values are selected for the first report execution: All values, first or last value. This may be used for dynamic list. |
| Type | (Inherited from MetaColumn) |
| TypeEd |
Data type of the column
(Inherited from ReportElement) |
| TypeEl |
Final type of the element
(Inherited from ReportElement) |
| TypeRe | Data type of the restriction |
| Value1 | Value used for the restriction. Multiple values can be set (one per line). |
| Value2 | Second value used for the restriction |
| Value3 | Third value used for the restriction |
| Value4 | Fourth value used for the restriction |
| ValueHtmlId | Html identifier for the restriction value |
| XAxisType |
Not used (FUTURE). Definition of the X axis of the serie (Primary or Secondary).
(Inherited from ReportElement) |
| YAxisType |
Definition of the Y axis of the serie (Primary or Secondary)
(Inherited from ReportElement) |
Methods| Name | Description | |
|---|---|---|
| AddEnumValue | Helper to add an enum value to the restriction using its string value (Value or Id) |
| ChangeColumnGUID |
Helper to change the column of the element
(Inherited from ReportElement) |
| CopyForPrompt | Copy restriction property from another prompted restriction |
 | CreateReportRestriction | Create a default report restriction |
| ElementDisplayValue |
Display value of the element
(Inherited from ReportElement) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GeNavigationDisplayValue | Display value for navigation |
| GetD3Format |
D3 Format for a charts
(Inherited from ReportElement) |
| GetEnumDisplayValue | Helper to return the display value of an enum from its id |
| GetEnumMessage | Enum message defined in the MetaData |
| GetEnumSortValue |
Get the sort value for an enumerated list
(Inherited from ReportElement) |
| GetExcelFormat |
Excel Format of the element
(Inherited from ReportElement) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetHtmlValue | HTML value of the restriction for index 1,2,3 or 4 |
| GetMomentJSFormat |
Moment JS Format for the chart
(Inherited from ReportElement) |
| GetOperatorLabel | Operator label translated |
| GetSort |
The display order
(Inherited from MetaColumn) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| HasDateKeyword | Helper to find if a string has a date keyword |
| Init |
Init the editor objects
(Inherited from RootEditor) |
| InitDefaultValues |
Init the default values
(Inherited from RootEditor) |
| InitEditor |
Init the editor objects and the default values
(Inherited from RootEditor) |
| IsIdenticalForPrompt | True if the restriction is consider as identical for prompt: only one restriction will be generated in the report Same name and same source column |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| SetDefaultFormat |
Set default format defined in the repository configuration accroding to the type
(Inherited from MetaColumn) |
| SetDefaults |
Depending on the element type, set default aggreate functions: AggregateFunction, TotalAggregateFunction
(Inherited from ReportElement) |
| SetEnumHtmlIds | Initialize the Html Ids of the enum values of the restriction |
| SetNavigationValue | Set a restriction value for navigation |
| SetReadOnly |
Set all properties to readonly
(Inherited from RootEditor) |
| SetSourceReference |
Change the source of the element, set MetColumn to NULL
(Inherited from ReportElement) |
| SetStandardFormat |
Set standard format accroding to the type
(Inherited from MetaColumn) |
| ShouldSerializeCaseSensitive | |
| ShouldSerializeContainsHtml | (Inherited from ReportElement) |
| ShouldSerializeCssTitle | (Inherited from ReportElement) |
| ShouldSerializeDateTimeStandardFormatRe | |
| ShouldSerializeDrillUpOnlyIfDD | (Inherited from MetaColumn) |
| ShouldSerializeEnumLayout | |
| ShouldSerializeFirstSelection | |
| ShouldSerializeInsertPosition | (Inherited from ReportElement) |
| ShouldSerializeOperatorStyle | |
| ShouldSerializeShowAllEnums | (Inherited from ReportElement) |
| ShouldSerializeTriggerExecution | |
| ShouldSerializeTypeRe | |
| ToString |
Name of the restriction
(Overrides ObjectToString) |
| UpdateEditor |
Update editor attributes
(Inherited from RootEditor) |
| UpdateEditorAttributes |
Refresh properties attrivutes
(Inherited from RootEditor) |
Fields| Name | Description | |
|---|---|---|
 | _datetimeStandardFormat | (Inherited from MetaColumn) |
| _dctd | (Inherited from RootEditor) |
| _displayName | (Inherited from MetaColumn) |
| _enumGUID | (Inherited from MetaColumn) |
| _format | (Inherited from MetaColumn) |
| _GUID | (Inherited from RootComponent) |
| _model |
Current model
(Inherited from ReportElement) |
| _name | (Inherited from RootComponent) |
| _numericStandardFormat | (Inherited from MetaColumn) |
| _report |
Current report
(Inherited from ReportElement) |
| _source | (Inherited from MetaColumn) |
| _SQL | (Inherited from ReportElement) |
| _type |
Data type of the column
(Inherited from MetaColumn) |
 | IsCommonValue |
True is the element is a common value
(Inherited from ReportElement) |
| IsForNavigation |
True if navigation occured
(Inherited from ReportElement) |
| IsViewRestriction | True is the restriction is for a restriction view |
| kStartRestrictionChar | Start character of a restriction |
| kStopRestrictionChar | Stop character of a restriction |
| ValidationErrors | Validation errors set during the execution |
See Also