ITaxonomyManagerCategories Method (Int32, ILocale, String, Boolean, Int32, Int32)
|
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.308
Syntax IEnumerable<ICategoryNode> Categories(
out int count,
ILocale locale = null,
string nameInitialLetters = "",
bool searchSynonyms = false,
int pageSize = -1,
int startIndex = -1
)
Function Categories (
<OutAttribute> ByRef count As Integer,
Optional locale As ILocale = Nothing,
Optional nameInitialLetters As String = "",
Optional searchSynonyms As Boolean = false,
Optional pageSize As Integer = -1,
Optional startIndex As Integer = -1
) As IEnumerable(Of ICategoryNode)
IEnumerable<ICategoryNode^>^ Categories(
[OutAttribute] int% count,
ILocale^ locale = nullptr,
String^ nameInitialLetters = L"",
bool searchSynonyms = false,
int pageSize = -1,
int startIndex = -1
)
abstract Categories :
count : int byref *
?locale : ILocale *
?nameInitialLetters : string *
?searchSynonyms : bool *
?pageSize : int *
?startIndex : int
(* Defaults:
let _locale = defaultArg locale null
let _nameInitialLetters = defaultArg nameInitialLetters ""
let _searchSynonyms = defaultArg searchSynonyms false
let _pageSize = defaultArg pageSize -1
let _startIndex = defaultArg startIndex -1
*)
-> IEnumerable<ICategoryNode>
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