|
Set and get and active category. This property doesn't work if allowExpandMultipleCategories is true. Its default value is empty.
- Type:
-
string readonly
- Implemented in:
-
QuestionToolbox
- See also:
-
allowExpandMultipleCategories *
, expandCategory *
, collapseCategory
|
|
Add a copied Question into Toolbox
- Type:
-
(question: any, options?: any) => void
- Parameters:
-
question, type: any
, a copied Survey.Question
options, type: any
, a json object that allows you to override question properties. Attributes are: name, title, tooltip, isCopied, iconName, json and category.
- Implemented in:
-
QuestionToolbox
|
|
Add toolbox items into the Toolbox
- Type:
-
(items: any, clearAll?: boolean) => void
- Parameters:
-
items, type: any
, the list of new items
clearAll, type: boolean
, set it to true to clear all previous items.
- Implemented in:
-
QuestionToolbox
|
|
allowExpandMultipleCategories
property
|
|
Set it to true, to allow end-user to expand more than one category. There will no active category in this case
- Type:
-
boolean writable
- Implemented in:
-
QuestionToolbox
- See also:
-
activeCategory
|
|
Contains toolbox categories and allows you to modify them.
View Demo
- Type:
-
any readonly
- Implemented in:
-
QuestionToolbox
|
|
Change categories for several toolbox items.
- Type:
-
(changedItems: any) => void
- Parameters:
-
changedItems, type: any
, the array of objects {name: "your toolbox item name", category: "new category name"}
- Implemented in:
-
QuestionToolbox
|
|
Change the category of the toolbox item
- Type:
-
(name: string, category: string) => void
- Parameters:
-
name, type: string
, the toolbox item name
category, type: string
, new category name
- Implemented in:
-
QuestionToolbox
|
|
Remove all copied toolbox items.
- Type:
-
() => void
- Implemented in:
-
QuestionToolbox
|
|
Remove all toolbox items.
- Type:
-
() => void
- Implemented in:
-
QuestionToolbox
|
|
Collapse all categories. If allowExpandMultipleCategories is false (default value) this function does nothing
- Type:
-
() => void
- Implemented in:
-
QuestionToolbox
- See also:
-
allowExpandMultipleCategories
|
|
Collapse a category by its name. If allowExpandMultipleCategories is false (default value) this function does nothing
- Type:
-
(categoryName: string) => void
- Parameters:
-
categoryName, type: string
, the category name
- Implemented in:
-
QuestionToolbox
- See also:
-
allowExpandMultipleCategories
|
|
The maximum number of copied toolbox items. If an user adding copiedItemMaxCount + 1 item, the first added item will be removed.
- Type:
-
number readonly
- Implemented in:
-
QuestionToolbox
|
|
The Array of copied Toolbox items
- Type:
-
any readonly
- Implemented in:
-
QuestionToolbox
|
|
The Array of copied Toolbox items as Text JSON.
- Type:
-
string writable
- Implemented in:
-
QuestionToolbox
|
|
expandAllCategories
method
|
|
Expand all categories. If allowExpandMultipleCategories is false (default value) this function does nothing
- Type:
-
() => void
- Implemented in:
-
QuestionToolbox
- See also:
-
allowExpandMultipleCategories
|
|
expandCategory
method
|
|
Expand a category by its name. If allowExpandMultipleCategories is false (default value), all other categories become collapsed
- Type:
-
(categoryName: string) => void
- Parameters:
-
categoryName, type: string
, the category name
- Implemented in:
-
QuestionToolbox
- See also:
-
allowExpandMultipleCategories *
, collapseCategory
|
|
Specifies whether the toolbox should be in compact or full mode.
Accepts the following values:
true - Toolbox is always in compact mode.
false - Toolbox is always in full mode.
undefined - Toolbox switches between the full and compact modes automatically based on available width.
- Type:
-
boolean readonly
- Implemented in:
-
QuestionToolbox
- See also:
-
isCompact
|
|
- Type:
-
(item: IQuestionToolboxItem) => QuestionToolboxItem
- Parameters:
-
item, type: IQuestionToolboxItem
, the toolbox item description
- Implemented in:
-
QuestionToolbox
- See also:
-
IQuestionToolboxItem
|
|
Returns toolbox item by its name. Returns null if there is no toolbox item with this name
- Type:
-
(name: string) => IQuestionToolboxItem
- Parameters:
-
name, type: string
- Implemented in:
-
QuestionToolbox
|
|
Indicates whether the toolbox is currently in compact mode.
- Type:
-
boolean readonly
- Implemented in:
-
QuestionToolbox
- See also:
-
forceCompact
|
|
The Array of Toolbox items.
- Type:
-
any readonly
- Implemented in:
-
QuestionToolbox
|
|
The Array of Toolbox items as Text JSON.
- Type:
-
string writable
- Implemented in:
-
QuestionToolbox
|
|
keepAllCategoriesExpanded
property
|
|
Set it to true to expand all categories and hide expand/collapse category buttons
- Type:
-
boolean writable
- Implemented in:
-
QuestionToolbox
|
|
Modify this array to change the toolbox items order.
- Type:
-
{} writable
- Implemented in:
-
QuestionToolbox
|
|
Removes categories from the Toolbox.
- Type:
-
() => void
- Implemented in:
-
QuestionToolbox
|
|
Remove a toolbox item by its name
- Type:
-
(name: string) => boolean
- Parameters:
-
name, type: string
, toolbox item name
- Implemented in:
-
QuestionToolbox
- See also:
-
IQuestionToolboxItem
|
|
Add a new toolbox item, add delete the old item with the same name
- Type:
-
(item: IQuestionToolboxItem) => boolean
- Parameters:
-
item, type: IQuestionToolboxItem
, the toolbox item description
- Implemented in:
-
QuestionToolbox
- See also:
-
IQuestionToolboxItem
|
|
Specifies whether to display category titles in the Toolbox.
If you disable this property, the Toolbox hides the titles but continues to display horizontal lines that divide categories. To remove these lines as well, call the removeCategories() method.
- Type:
-
boolean writable
- Implemented in:
-
QuestionToolbox
- See also:
-
removeCategories
|