Property | Type | Description | |
---|---|---|---|
AddCustomFilter | IControlHabanero | ||
CreateClearButton | IButton | ||
CreateFilterButton | IButton | ||
CreateFilterButtons | void | ||
FireFilterEvent | void |
Method | Description | |
---|---|---|
AddBooleanFilterCheckBox ( string labelText, string propertyName, bool defaultValue ) : ICheckBox |
Adds a CheckBox filter that displays only rows whose boolean value matches the on-off state of the CheckBox. The column of data must have "true" or "false" as its values (boolean database fields are usually converted to true/false string values by the Habanero object manager).
|
|
AddBooleanFilterComboBox ( string labelText, string propertyName, bool defaultValue ) : IComboBox |
Adds a ComboBox filter that displays only rows whose boolean value matches the true/false or null value in the ComboBox. The column (propertyName) of data must have "true" or "false" as its values (boolean database fields are usually converted to true/false string values by the Habanero object manager).
|
|
AddCustomFilter ( string labelText, ICustomFilter customFilter ) : void |
Adds a custom filter which allows filtering using an ICustomFilter
|
|
AddDateFilterDateTimePicker ( string labelText, string propertyName, System.DateTime defaultValue, FilterClauseOperator filterClauseOperator, bool nullable ) : IDateTimePicker |
Adds a date-time picker that filters a date column on the date chosen by the user. The given operator compares the chosen date with the date shown in the given column name.
|
|
AddDateRangeFilterComboBox ( string labelText, string columnName ) : IDateRangeComboBox |
Adds a DateRangeComboBox filter which provides common date ranges such as "Today" or "This Year", so that the grid will only show rows having a date property in the given range.
|
|
AddDateRangeFilterComboBox ( string labelText, string columnName, List |
Adds a DateRangeComboBox filter which provides common date ranges such as "Today" or "This Year", so that the grid will only show rows having a date property in the given range
|
|
AddDateRangeFilterComboBox ( string labelText, string columnName, bool includeStartDate, bool includeEndDate ) : IDateRangeComboBox |
Adds a DateRangeComboBox filter which provides common date ranges such as "Today" or "This Year", so that the grid will only show rows having a date property in the given range
|
|
AddDefaultClearClickEvent ( ) : void |
Adds the default Click Event. Enables the developer to add the default functionality back on the button click if previously removed.
|
|
AddDefaultFilterClickEvent ( ) : void |
Adds the default Click Event. Enables the developer to add the default functionality back on the button click if previously removed.
|
|
AddEnumFilterComboBox ( string labelText, string propertyName, |
Adds a Filter Combo box for filtering an enum data type.
|
|
AddMultiplePropStringTextBox ( string labelText, List |
Adds a TextBox filter in which users can specify text that multiple string-value columns will be filtered on. This uses a "like" operator and accepts any strings that contain the provided clause.
|
|
AddMultiplePropStringTextBox ( string labelText, List |
Adds a TextBox filter in which users can specify text that multiple string-value columns will be filtered on.
|
|
AddStaticStringFilterClause ( string propertyName, FilterClauseOperator filterClauseOperator, string filterValue ) : void |
Adds a static string filter StringStaticFilter to the Filter Control. This allows the developer to set a filter that is always applied and is not modifiable by or visible to the end user.
|
|
AddStringFilterComboBox ( string labelText, string propertyName, ICollection options, bool strictMatch ) : IComboBox |
Adds a ComboBox filter control
|
|
AddStringFilterTextBox ( string labelText, string propertyName ) : ITextBox |
Adds a TextBox filter in which users can specify text that a string-value column will be filtered on. This uses a "like" operator and accepts any strings that contain the provided clause.
|
|
AddStringFilterTextBox ( string labelText, string propertyName, FilterClauseOperator filterClauseOperator ) : ITextBox |
Adds a TextBox filter in which users can specify text that a string-value column will be filtered on.
|
|
ApplyFilter ( ) : void |
Applies the filter that has been captured. This allows an external control (e.g. another button click) to be used as the event that causes the filter to fire. Typically used when the filter controls are being set manually.
|
|
ClearFilters ( ) : void |
Clears all the values from the filter and calls IFilterControl.ApplyFilter
|
|
FilterControlVWG ( IControlFactory controlFactory ) : System |
|
|
GetChildControl ( string propertyName ) : IControlHabanero |
Returns the filter control for the propertyName
|
|
GetFilterClause ( ) : IFilterClause |
Returns the filter clause as a composite of all the specific clauses in each filter control in the set
|
|
RemoveDefaultClearClickEvent ( ) : void |
Removes the default Click Event. Enables the developer to add custom functionality on the button click before the Clear or search happens.
|
|
RemoveDefaultFilterClickEvent ( ) : void |
Removes the default Click Event. Enables the developer to add custom functionality on the button click before the filter or search happens.
|
Method | Description | |
---|---|---|
AddCustomFilter ( string labelText, string propertyName, ICustomFilter customFilter ) : IControlHabanero | ||
CreateClearButton ( int buttonWidth, int buttonHeight ) : IButton | ||
CreateFilterButton ( int buttonWidth, int buttonHeight ) : IButton | ||
CreateFilterButtons ( IPanel filterButtonPanel ) : void | ||
FireFilterEvent ( ) : void |
public AddBooleanFilterCheckBox ( string labelText, string propertyName, bool defaultValue ) : ICheckBox | ||
labelText | string | The label to appear before the control |
propertyName | string | The business object property on which to filter |
defaultValue | bool | Whether the CheckBox is checked |
return | ICheckBox |
public AddBooleanFilterComboBox ( string labelText, string propertyName, bool defaultValue ) : IComboBox | ||
labelText | string | The label to appear before the control |
propertyName | string | The business object property on which to filter |
defaultValue | bool | Whether the CheckBox is checked |
return | IComboBox |
public AddCustomFilter ( string labelText, ICustomFilter customFilter ) : void | ||
labelText | string | The Label to appear before the control |
customFilter | ICustomFilter | The custom filter |
return | void |
public AddDateFilterDateTimePicker ( string labelText, string propertyName, System.DateTime defaultValue, FilterClauseOperator filterClauseOperator, bool nullable ) : IDateTimePicker | ||
labelText | string | The label to appear before the control |
propertyName | string | The business object property on which to filter |
defaultValue | System.DateTime | The default date or null |
filterClauseOperator | FilterClauseOperator | The operator used to compare /// with the date chosen by the user. The chosen date is on the /// right side of the equation. |
nullable | bool | Whether the datetime picker allows null values |
return | IDateTimePicker |
public AddDateRangeFilterComboBox ( string labelText, string columnName ) : IDateRangeComboBox | ||
labelText | string | The label to appear before the control |
columnName | string | The business object property on which to filter |
return | IDateRangeComboBox |
public AddDateRangeFilterComboBox ( string labelText, string columnName, List |
||
labelText | string | The label to appear before the control |
columnName | string | The business object property on which to filter |
options | List |
Provides a specific set of date range options to show |
includeStartDate | bool | Includes all dates that match the start date exactly |
includeEndDate | bool | Includes all dates that match the end date exactly |
return | IDateRangeComboBox |
public AddDateRangeFilterComboBox ( string labelText, string columnName, bool includeStartDate, bool includeEndDate ) : IDateRangeComboBox | ||
labelText | string | The label to appear before the control |
columnName | string | The business object property on which to filter |
includeStartDate | bool | Includes all dates that match the start date exactly |
includeEndDate | bool | Includes all dates that match the end date exactly |
return | IDateRangeComboBox |
public AddEnumFilterComboBox ( string labelText, string propertyName, |
||
labelText | string | The label to appear before the control |
propertyName | string | The business object property on which to filter |
enumType | The Type being showen in the ComboBox | |
return | IComboBox |
public AddMultiplePropStringTextBox ( string labelText, List |
||
labelText | string | The label to appear before the control |
propertyNames | List |
The business object propertys on which to filter |
return | ITextBox |
public AddMultiplePropStringTextBox ( string labelText, List |
||
labelText | string | The label to appear before the control |
propertyNames | List |
The business object propertys on which to filter |
filterClauseOperator | FilterClauseOperator | The operator to use for the filter clause |
return | ITextBox |
public AddStaticStringFilterClause ( string propertyName, FilterClauseOperator filterClauseOperator, string filterValue ) : void | ||
propertyName | string | |
filterClauseOperator | FilterClauseOperator | |
filterValue | string | |
return | void |
public AddStringFilterComboBox ( string labelText, string propertyName, ICollection options, bool strictMatch ) : IComboBox | ||
labelText | string | The label to appear before the control |
propertyName | string | The business object property on which to filter |
options | ICollection | The collection of items used to fill the combo box. |
strictMatch | bool | Whether to filter the DataGridView column on a strict match or using a LIKE operator |
return | IComboBox |
public AddStringFilterTextBox ( string labelText, string propertyName ) : ITextBox | ||
labelText | string | The label to appear before the control |
propertyName | string | The business object property on which to filter |
return | ITextBox |
public AddStringFilterTextBox ( string labelText, string propertyName, FilterClauseOperator filterClauseOperator ) : ITextBox | ||
labelText | string | The label to appear before the control |
propertyName | string | The business object property on which to filter |
filterClauseOperator | FilterClauseOperator | The operator to use for the filter clause |
return | ITextBox |
public FilterControlVWG ( IControlFactory controlFactory ) : System | ||
controlFactory | IControlFactory | |
return | System |
public GetChildControl ( string propertyName ) : IControlHabanero | ||
propertyName | string | |
return | IControlHabanero |
public RemoveDefaultClearClickEvent ( ) : void | ||
return | void |
public RemoveDefaultFilterClickEvent ( ) : void | ||
return | void |