Gets Category Nodes by initial characters in name, filtered by locale, in a paginated fashion.
This is the main way of searching for categories. By default, it returns all categories with all input parameters missing.
Namespace: Ingeniux.CMS
Assembly: Ingeniux.CMS.CSAPI (in Ingeniux.CMS.CSAPI.dll) Version: 9.0.565.0 (9.0.565)
Syntax
IEnumerable<ICategoryNode> Categories( out int count, ILocale locale = null, string nameInitialLetters = "", bool searchSynonyms = false, int pageSize = -1, int startIndex = -1 )
Parameters
- count
- Type: SystemInt32
Total count of all matching categories - locale (Optional)
- Type: Ingeniux.CMSILocale
The locale in which to search. If missing or null, uses the taxonomy manger's current locale. - nameInitialLetters (Optional)
- Type: SystemString
The initial characters to search for in a category name. If the locale is not the creation locale of a category, searches translated name for that locale. - searchSynonyms (Optional)
- Type: SystemBoolean
Specifies whether or not to search synonyms - pageSize (Optional)
- Type: SystemInt32
Number of entries to return. If not provided, returns all entries. - startIndex (Optional)
- Type: SystemInt32
Starting index of entries. If not provided, starts from the first entry.
Return Value
Type: IEnumerableICategoryNodeCollection of category node instances matching the criteria.
See Also