The HierarchicalQuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum, TQueryChildrenSettings>)>)> type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | HierarchicalQuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum, TQueryChildrenSettings>)>)>()()()() |
Initializes a new instance of the HierarchicalQuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum, TQueryChildrenSettings>)>)> class,
using default settings. Use the Set... functions toe configure
the this HierarchicalQuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum, TQueryChildrenSettings>)>)> object.
|
| HierarchicalQuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum, TQueryChildrenSettings>)>)>(HierarchicalQuerySettings<(Of <<'(TConfigurationObject, TPropertyEnum, TQueryChildrenSettings>)>>)) |
Initializes a new instance of the HierarchicalQuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum, TQueryChildrenSettings>)>)> class,
using default settings. Use the Set... functions to configure
this HierarchicalQuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum, TQueryChildrenSettings>)>)> object.
|
Methods
| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
 | Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetChildQuerySettings |
Sets the child query settings. When performing a hierarchical query, in addition to the filtering, sorting, etc...
done one this query, all of those behaviors can be performed on the child objects as well.
|
| SetFilterDefinition(FilterDefinition<(Of <<'(TConfigurationObject, TPropertyEnum>)>>)) |
Sets the filter definition that control how the result set is filtered. If no filter is specified
the results will be unfiltered.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetFilterDefinition(TPropertyEnum, Object) |
Sets the filter definition to filter the results by the filteredProperty,
using a Prefix filter match type.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetFilterDefinition(TPropertyEnum, Object, FilterMatchType) |
Sets the filter definition to filter the results by the filteredProperty.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetLanguageToRetrieve |
Sets the language to retrieve.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.)
|
| SetLanguageToRetrieveToAll |
Sets the language to retrieve to all languages.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetLanguageToRetrieveToDefault |
Sets the language to retrieve to the default language.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetPropertiesToRetrieve(IEnumerable<(Of <<'(TPropertyEnum>)>>)) |
Sets the properties that this settings will query. If no properties are specified
ID and display name are queried.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetPropertiesToRetrieve(array<TPropertyEnum>[]()[][]) |
Sets the properties that this settings will query. If no properties are specified
ID and display name are queried.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetPropertiesToRetrieveToAll |
Sets this query to retrieve all properties on the objects.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetResultCountLimit(Int32) |
Sets the maximum number of results to retrieve with this query. If no limit is specified
the results will use a dynamic limit.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetResultCountLimit(QueryResultLimit) |
Sets the maximum number of results to retrieve with this query. If no limit is specified
the results will use a dynamic limit.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetRightsFilter(array<RightsQueryFilter<(Of <<'(TConfigurationObject>)>>)>[]()[][]) |
Sets the list of rights to filter the result set against. If no rights are specified
the view right will be used.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetRightsFilter(IEnumerable<(Of <<'(RightsQueryFilter<(Of <<'(TConfigurationObject>)>>)>)>>)) |
Sets the list of rights to filter the result set against. If no rights are specified
the view right will be used.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetRightsFilterToAdmin |
Sets the rights filter to use the default admin right for this object.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetRightsFilterToView |
Sets the rights filter to use the default view right for this object.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetSortOrder(SortDefinition<(Of <<'(TPropertyEnum>)>>)) |
Sets the sort order to be applied to this query. If no sort order is specified,
a default order of ascending display name will be applied.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetSortOrder(TPropertyEnum, ListSortDirection) |
Sets the sort order to be applied to this query. If no sort order is specified,
a default order of ascending display name will be applied.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SetStartAtRecordNumber |
Sets the record number to start at for the query results. By default, the record number starts at zero (to start at the beginning).
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SupportsValueListFiltering |
Determines if value list filtering via ValueListFilterDefinition<(Of <(<'TFilteredObject, TPropertyEnum>)>)> is supported.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| ToString | Returns a String that represents the current Object. (Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
Properties
| Name | Description | |
|---|---|---|
 | ChildQueries |
Gets the child query settings.
|
| FilterDefinition |
Gets the filter definition.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| Language |
Gets the language.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| PropertiesInQuery |
Gets the properties of the object that are to be included in the query results.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| ResultCountLimit |
Gets the result count limit or nullNothingnullptra null reference (Nothing in Visual Basic) if the results are unlimited.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| RightsFilters |
Gets the list of rights that will filter the search results.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| SortDefinition |
Gets the sort definition.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
| StartAtRecordNumber |
Gets the starting record number of the query results that will be returned.
(Inherited from QuerySettings<(Of <(<'TConfigurationObject, TPropertyEnum>)>)>.) |
