This class represents settings for a Configuration query that
provides a filtered and sorted set of results.
CreateQuerySettings()()()() can be used to construct an appropriate
QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)> instance. The Set functions can be used
to override default values.
Namespace: ININ.IceLib.ConfigurationAssembly: ININ.IceLib.Configuration (in ININ.IceLib.Configuration.dll) Version: 0.0.0.0 (22.3.0.218)
Syntax
C# |
---|
public class QuerySettings<TConfigurationObject, TPropertyEnum> where TConfigurationObject : ConfigurationObject where TPropertyEnum : struct, new() |
Visual Basic |
---|
Public Class QuerySettings(Of TConfigurationObject As ConfigurationObject, TPropertyEnum As {Structure, New}) |
Type Parameters
- TConfigurationObject
- The type of the configuration object.
- TPropertyEnum
- The type of the property enumeration.
Remarks
The QuerySettings class is constructed with default values to use a dynamic limit to return all IDs and
display names that the current user has view access to. This list is sorted ascending by display name.
This query can be customized by calling the set functions. Calling a Set function will replace the existing
settings for that item with the specified new values. For example, calling SetPropertiesToQuery will replace
the existing property list. Calling a set function with nullNothingnullptra null reference (Nothing in Visual Basic) will cause that item to revert
to the default values.
All set functions return a this pointer to allow for optional fluent syntax.
CreateQuerySettings()()()() is provided
to allow a simple method to create a default QuerySettings object that can be further customized.
Inheritance Hierarchy
System..::..Object
ININ.IceLib.Configuration..::..QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>
ININ.IceLib.Configuration..::..HierarchicalQuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum, TQueryChildrenSettings>)>)>
ININ.IceLib.Configuration..::..QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>
ININ.IceLib.Configuration..::..HierarchicalQuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum, TQueryChildrenSettings>)>)>
Version Information
Supported for IC Server version 2015 R1 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 SU 7 and beyond.
For 4.0, supported for IC Server version 4.0 GA and beyond.
For 3.0, supported for IC Server version 3.0 SU 7 and beyond.