API Reference
DataTablesSearchBuilderBuilder
Fluent builder used to configure the DataTables SearchBuilder plugin without having to create the underlying option objects manually. This allows complex groups and custom operators to be declared using a C# API and serialized to the structure expected by DataTables.
Inheritance
- Object
- DataTablesSearchBuilderBuilder
Constructors
public DataTablesSearchBuilderBuilder() #Methods
Build() #Finalises configuration and returns the resulting DataTablesSearchBuilder instance.
Returns
The configured DataTablesSearchBuilder.
public DataTablesSearchBuilderBuilder Conditions(Int32 count) #DataTablesSearchBuilderBuilderSets the default number of conditions that will be available to the user when SearchBuilder is first initialised.
Parameters
- count System.Int32
- Number of conditions.
Returns
The current builder instance.
public DataTablesSearchBuilderBuilder CustomOperator(String name, String javascript) #DataTablesSearchBuilderBuilderRegisters a custom filtering operator.
Parameters
- name System.String
- Name of the operator as used by DataTables.
- javascript System.String
- JavaScript implementation of the operator.
Returns
The current builder instance.
public DataTablesSearchBuilderBuilder CustomOperator(DataTablesBuiltInOperator op) #DataTablesSearchBuilderBuilderAdds one of the predefined operators provided by DataTablesSearchBuiltIns.
Parameters
- op HtmlForgeX.DataTablesBuiltInOperator
- Identifier of the built-in operator.
Returns
The current builder instance.
public DataTablesSearchBuilderBuilder Enable(Boolean enable = true) #DataTablesSearchBuilderBuilderEnables or disables the SearchBuilder plug-in for the table.
Parameters
- enable System.Boolean = true
- Whether SearchBuilder should be enabled.
Returns
The current builder instance.
public DataTablesSearchBuilderBuilder Greyscale(Boolean greyscale = true) #DataTablesSearchBuilderBuilderEnables grey-scale colour scheme which can improve readability on some backgrounds.
Parameters
- greyscale System.Boolean = true
- Value indicating whether grey-scale styling should be used.
Returns
The current builder instance.
public DataTablesSearchBuilderBuilder Group(Action<DataTablesSearchGroupBuilder> configure) #DataTablesSearchBuilderBuilderAdds a group of conditions to the SearchBuilder configuration.
Parameters
- configure System.Action{HtmlForgeX.DataTablesSearchGroupBuilder}
- Delegate used to configure the group.
Returns
The current builder instance.
public DataTablesSearchBuilderBuilder Logic(DataTablesSearchLogic logic) #DataTablesSearchBuilderBuilderDefines the logical operator used between top level groups.
Parameters
- logic System.String
- Value to assign, typically "AND" or "OR".
Returns
The current builder instance.
Logic(HtmlForgeX.DataTablesSearchLogic logic) #Defines the logical operator used between top level groups using a typed enumeration.
Parameters
- logic HtmlForgeX.DataTablesSearchLogic
public DataTablesSearchBuilderBuilder PreDefined(Object predefined) #DataTablesSearchBuilderBuilderInjects a predefined SearchBuilder configuration object. Useful for restoring a previous state.
Parameters
- predefined System.Object
- Object describing SearchBuilder state.
Returns
The current builder instance.