Skip to content

gridifyGlobalConfiguration.md

Latest commit

 

History

History
91 lines (54 loc) · 3.11 KB

gridifyGlobalConfiguration.md

File metadata and controls

91 lines (54 loc) · 3.11 KB

GridifyGlobalConfiguration

Using this class, you can change the default behavior and configuration of the Gridify library.

General configurations

DefaultPageSize

The default page size for the paging methods when no page size is specified.

  • type: int
  • default: 20

CaseSensitiveMapper

By default mappings are case insensitive. For example, name=John and Name=John are considered equal. You can change this behavior by setting this property to true.

AllowNullSearch

This option enables the null keyword in filtering operations. For example, name=null searches for all records with a null value for the name field, not the string "null". If you need to search for the literal string "null", disable this option.

IgnoreNotMappedFields

If true, Gridify doesn't throw exceptions during filtering and ordering operations when a mapping is not defined for the given field.

DisableNullChecks

By default, Gridify adds null-checking conditions on nested collections to prevent null reference exceptions, e.g., () => field != null && field....

Some ORMs like NHibernate don't support this. You can disable this behavior by setting this option to true.

  • type: bool
  • default: false

AvoidNullReference

This option allows intermediate objects to be null.

For example, in obj.PropA.PropB, PropA can be null.

This configuration is specific to properties and was introduced after DisableNullChecks.

  • type: bool
  • default: false

CaseInsensitiveFiltering

If true, string comparison operations are case insensitive by default.

  • type: bool
  • default: false

AllowFieldToFieldComparison

Enables field-to-field comparison in filtering expressions. When enabled, the right-hand side of a filter condition can reference another mapped field using the (fieldName) syntax. For example: age>(minAge).

This option is disabled by default to avoid any breaking changes for existing users. You must opt in explicitly.

DefaultDateTimeKind

By default, Gridify uses the DateTimeKind.Unspecified when parsing dates. You can change this behavior by setting this property to DateTimeKind.Utc or DateTimeKind.Local. This option is useful when you want to use Gridify with a database that requires a specific DateTimeKind, for example when using npgsql and postgresql.

  • type: DateTimeKind
  • default: null

CustomOperators

Using the Register method of this property you can add your own custom operators.

 GridifyGlobalConfiguration.CustomOperators.Register<MyCustomOperator>();

To learn more about custom operators, see Custom operator