QuestionToolbox, SurveyJS Creator Documentation

The list of Toolbox items.

Type to filter the list:

	activeCategory property
	Set and get and active category. This property doesn't work if allowExpandMultipleCategories is true. Its default value is empty. Type: string writable Implemented in: QuestionToolbox See also: allowExpandMultipleCategories * , expandCategory * , collapseCategory
	addCopiedItem method
	Add a copied Question into Toolbox Type: (question: Question, options?: any) => void Parameters: question, type: Question , 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
	addItem method
	Add a toolbox item Type: (item: IQuestionToolboxItem, index?: number) => void Parameters: item, type: IQuestionToolboxItem , the toolbox item description index, type: number , the toolbox index to place the item, the item is added to the end if index not passed Implemented in: QuestionToolbox See also: IQuestionToolboxItem
	addItems method
	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
	changeCategories method
	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
	changeCategory method
	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
	clearCopiedItems method
	Remove all copied toolbox items. Type: () => void Implemented in: QuestionToolbox
	clearItems method
	Remove all toolbox items. Type: () => void Implemented in: QuestionToolbox
	collapseAllCategories method
	Collapse all categories. If allowExpandMultipleCategories is false (default value) this function does nothing Type: () => void Implemented in: QuestionToolbox See also: allowExpandMultipleCategories
	collapseCategory method
	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
	copiedItemMaxCount property
	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
	copiedItems property
	The Array of copied Toolbox items Type: any readonly Implemented in: QuestionToolbox
	copiedJsonText property
	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
	getItemByName method
	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
	items property
	The Array of Toolbox items. Type: any readonly Implemented in: QuestionToolbox
	jsonText property
	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
	orderedQuestions property
	Modify this array to change the toolbox items order. Type: {} writable Implemented in: QuestionToolbox
	removeItem method
	Remove a toolbox item by its name Type: (name: string) => boolean Parameters: name, type: string , toolbox item name Implemented in: QuestionToolbox See also: IQuestionToolboxItem
	replaceItem method
	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

QuestionToolbox

Why We Use Cookies