api.form

Подробное описание

Работа с текущей формой

api.form

Свойства

contentHeightSize [Number] - Высота страницы(только для openmode = dialog)

Открытые члены
	acceptedClassifiers (classId)
	Возвращает список доступных значений для указанного классификатора Подробнее...
	containsRowAttribute (code)
	Проверить наличие атрибута строчной части Подробнее...
	filterList ()
	Получить список фильтров Подробнее...
	isValid ()
	Признак, что форма доступна и инициализированна Подробнее...
	newRowsAttribute (code)
	Добавить новый атрибут строчной части Подробнее...
	onFilterReseted (func, callmode)
	Вызывает functionName, когда все фильтры сброшены Подробнее...
	onSelectedClassifiersReseted (func, callmode)
	Вызывает functionName после сброса всех фильтров по классификаторам Подробнее...
	onSkuListStatusChanged (func, callmode)
	Вызывает func, когда начинается или заканчивается пересчет фильтров, в func передается атрибут со значениями 'UpdateStarted' и 'UpdateFinished'. Подробнее...
	rowAttribute (code, itemId)
	Получить атрибут строчной части, если задан itemId, то возвращает атрибут строчной части заданного элемента Подробнее...
	rowItem (id)
	Получить элемент строчной части Подробнее...
	rowItemIdList ()
	Получить список id товаров на форме Подробнее...
	selectAllGroup ()
	Сбрасывает выбранные ранее группы товаров Подробнее...
	selectFilterById (id)
	Применить фильтр, если фильтр уже применен - убирает его Подробнее...
	selectNoFilter ()
	Сбрасывает все фильтры Подробнее...
	selectStandardFilter (code)
	Выбрать в документе один из стандартных фильтров Подробнее...
	setIsAllowFilterPanel (filterPanelAllow)
	Включить или выключить панели фильтров/товаров. Подробнее...
	setIsAllowNotify (allowNotify)
	Управление информационной панелью, которая отображает выбранные фильтры Подробнее...
	setRowAttributeValue (itemId, code, value, unit, isCheck)
	Установить значение атрибута товарного документа Подробнее...
	setRowModel (model)
	Установить товары на форме Подробнее...

Методы

acceptedClassifiers (classId)

* acceptedClassifiers

(

classId

)

Возвращает список доступных значений для указанного классификатора

Аргументы

classId

[ID] - Идентификатор классификатора

Возвращает

FilterClassifierValue[] - Список значений классификатора, по которым может осуществляться фильтрация товаров

containsRowAttribute (code)

containsRowAttribute

(

code

)

Проверить наличие атрибута строчной части

Аргументы

code	[AttributeCode] - Код атрибута. Для доп.атрибута, если код не задан, то следует передавать идентификатор атрибута

Возвращает

Boolean - Признак наличия

filterList ()

* filterList

(

)

Получить список фильтров

Возвращает

Filter[] - Список фильтров

isValid ()

isValid

(

)

Признак, что форма доступна и инициализированна

Возвращает

Boolean

newRowsAttribute (code)

* newRowsAttribute

(

code

)

Добавить новый атрибут строчной части

Аргументы

code	[AttributeCode or String] - Код атрибута

Возвращает

Attribute - Новый атрибут

onFilterReseted (func, callmode)

onFilterReseted	(	func	,
		callmode
	)

Вызывает functionName, когда все фильтры сброшены

Аргументы

func	[String or Function] - Вызываемая Функция или ее имя
callmode	[String] optional ('view') - Тип вызова, view - из html, script - из js

onSelectedClassifiersReseted (func, callmode)

onSelectedClassifiersReseted	(	func	,
		callmode
	)

Вызывает functionName после сброса всех фильтров по классификаторам

Аргументы

func	[String or Function] - Вызываемая Функция или ее имя
callmode	[String] optional ('view') - Тип вызова, view - из html, script - из js

onSkuListStatusChanged (func, callmode)

onSkuListStatusChanged	(	func	,
		callmode
	)

Вызывает func, когда начинается или заканчивается пересчет фильтров,
в func передается атрибут со значениями 'UpdateStarted' и 'UpdateFinished'.

Аргументы

func	[String or Function] - Вызываемая Функция или ее имя
callmode	[String] optional ('view') - Тип вызова, view - из html, script - из js

rowAttribute (code, itemId)

struct AttributeRole * rowAttribute	(	code	,
		itemId
	)

Получить атрибут строчной части, если задан itemId, то возвращает атрибут строчной части заданного элемента

Аргументы

code	[AttributeCode or String] - Код атрибута. Для доп.атрибута, если код не задан, то следует передавать идентификатор атрибута
itemId	[ID] optional - Идентификатор элемента

Возвращает

Attribute

rowItem (id)

* rowItem

(

id

)

Получить элемент строчной части

Аргументы

itemId

[ID] - Идентификатор элемента

Возвращает

RowItem

rowItemIdList ()

rowItemIdList

(

)

Получить список id товаров на форме

Возвращает

ID[] - список id элементов

selectAllGroup ()

selectAllGroup

(

)

Сбрасывает выбранные ранее группы товаров

selectFilterById (id)

selectFilterById

(

id

)

Применить фильтр, если фильтр уже применен - убирает его

Аргументы

id	[ID] - Идентификатор фильтра

selectNoFilter ()

selectNoFilter

(

)

Сбрасывает все фильтры

selectStandardFilter (code)

struct StandardFilterCode * selectStandardFilter

(

code

)

Выбрать в документе один из стандартных фильтров

Аргументы

code	[StandardFilterCode] - CodeKey фильтра

setIsAllowFilterPanel (filterPanelAllow)

setIsAllowFilterPanel

(

filterPanelAllow

)

Включить или выключить панели фильтров/товаров.

Аргументы

filterPanelAllow

[boolean] - Признак видимости

setIsAllowNotify (allowNotify)

setIsAllowNotify

(

allowNotify

)

Управление информационной панелью, которая отображает выбранные фильтры

Аргументы

allowNotify

[boolean] - Признак видимости

setRowAttributeValue (itemId, code, value, unit, isCheck)

setRowAttributeValue	(	itemId	,
		code	,
		value	,
		unit	,
		isCheck
	)

Установить значение атрибута товарного документа

Аргументы

itemId	[ID] - Идентификатор элемента (товара)
code	[AttributeCode] - Код атрибута. Для доп.атрибута, если код не задан, то следует передавать идентификатор атрибута
value	[String or Number] - Устанавливаемое значение
unit	[ID] - Идентификатор единицы измерения
isCheck	[Boolean] optional - Включение/отключение проверок возможности установки значения атрибута. Если проверки не пройдены, значение атрибута не будет добавлены. Значение по умолчанию true

Возвращает

Boolean - Признак успешной установки значения атрибута

setRowModel (model)

* setRowModel

(

model

)

Установить товары на форме

Метод сработает только в точке расширения preopen документа.
Модель нужно формировать полностью (т.е. для документов ЦО нужно прописывать как товары ЦО, так и товары дистрибьютора)
Если передан пустой список, то загрузится серийный список товаров

Аргументы

model

[IDList or SkuRowItem[]] - Список товаров