Click or drag to resize

ITaxonomyManagerCategories(Int32, ILocale, String, Boolean, Int32, Int32) Method


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: 10.6.492
Syntax
IEnumerable<ICategoryNode> Categories(
	out int count,
	ILocale locale = null,
	string nameInitialLetters = "",
	bool searchSynonyms = false,
	int pageSize = -1,
	int startIndex = -1
)

Parameters

count  Int32
Total count of all matching categories
locale  ILocale  (Optional)
The locale in which to search. If missing or null, uses the taxonomy manger's current locale.
nameInitialLetters  String  (Optional)
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  Boolean  (Optional)
Specifies whether or not to search synonyms
pageSize  Int32  (Optional)
Number of entries to return. If not provided, returns all entries.
startIndex  Int32  (Optional)
Starting index of entries. If not provided, starts from the first entry.

Return Value

IEnumerableICategoryNode
Collection of category node instances matching the criteria.
See Also