Documentation > CMS Template API Library > FilterParams
CrownPeak.CMSAPI.FilterParams : CrownPeak.CMSAPI.Params
Parameters to be used in Asset.GetFilterList.
| Name | Description | Type |
|---|---|---|
| Add | Adds a filter on a property to be compared as a . |
Method |
| Add | Adds a filter on a property to be compared as a . |
Method |
| Add | Adds a filter on a property to be compared as a . |
Method |
| Add | Adds a filter on a property to be compared as an . |
Method |
| Add | Adds a filter which checks a list for the presence of a property. |
Method |
| Add | Adds a filter which checks a list for the presence of a property. |
Method |
| Add | Adds a filter on a property to be compared as a . |
Method |
| Add | Adds a filter on a property for comparing asset type. |
Method |
| Add | Adds a filter on a field to be compared as a . |
Method |
| Add | Adds a filter on a field to be compared as a . Fields can be filtered as dates if they are between January 1, 1753, through December 31, 9999. This is a limitation of the database. It does not have the range of the DateTime data type in C#. |
Method |
| Add | Adds a filter on a field to be compared as a . Fields can be filtered as floats if they are a number in the range - 1.79E+308 to -2.23E-308, 0 and 2.23E-308 to 1.79E+308 . This is a limitation of the database storage. It does not have the range of a double in C#. |
Method |
| Add | Adds a filter on a field to be compared as an . |
Method |
| Add | Adds a filter which checks a list for the presence of a field. |
Method |
| Add | Adds a filter which checks a list for the presence of a field. |
Method |
| Add | Adds a filter on a field to be compared as a . |
Method |
| ExcludeProjectTypes | Whether to include projects, libraries and other special types when calling GetFilterList Defaults to true. |
Field |
| SetFieldNames | Sets the FieldNames property with the passed in strings. If the list was not empty, previously added items are cleared from the list. |
Method |
| SetFilterStatus | Sets the FilterStatus property with the passed in strings. If the list was not empty, previously added items are cleared from the list. |
Method |
| ExcludeFilterStatus | List of strings containing the names of statuses that should not be included in the result set. If this parameter is set (not null or empty), the FilterStatus parameter is ignored. Warning, this may cause undesirable effects during publishing. Use Caution. |
Property |
| FieldNames | The names of fields that will be preloaded into the returned assets. |
Property |
| FilterStatus | Names of the workflow statuses to filter on. If the ExcludeFilterStatus parameter is set (not null or empty), the FilterStatus parameter is ignored. Warning, this may cause undesirable effects during publishing. Use Caution. |
Property |
| Limit | The maximum number of assets to return. |
Property |
| SortOrder | The sort order that will be used in the upcoming query. |
Property |