Class isp api::FilterAction

Материал из ISPWiki
Перейти к: навигация, поиск

Класс isp_api::FilterAction


Описание:

class isp_api::FilterAction


Родители:


Потомки:


Открытые члены (кратко)

virtual void FormTune ( isp_api::Session &ses )

Защищённые члены (кратко)

virtual string OnSetValue ( Session &ses , string &data , mgr_xml::XmlNode node , const string &name , const string &value )

Метод вызывается для каждого установленного поля фильтра


virtual string AfterSet ( Session &ses , string &data )

Метод вызывается после просмотра всех параметров


virtual void Set ( Session &ses , const string &elid )

Вызывается после закрытия формы кнопкой ОК


virtual void Get ( Session &ses , const string &elid )

Вызывается перед показом формы

Методы

virtual void FormTune ( isp_api::Session &ses )

Метод для формирования формы с данными фитра

В большинстве случаев нет необходимости в изменении формы фильтра большинство операций может быть сделана через изменения метаданных

virtual string OnSetValue ( Session &ses , string &data , mgr_xml::XmlNode node , const string &name , const string &value )

Данный метод является защищённым

Метод вызывается для каждого установленного поля фильтра

Аргументы:
[ses] текущая сессия
[data] данные фильтра. Вы можете добавить любую информацию к этим данным
[node] узел xml описывающий поле фильтра
[name] имя параметра
[value] значение параметра
Returned: удобочитаемое представление параметра

virtual string AfterSet ( Session &ses , string &data )

Данный метод является защищённым

Метод вызывается после просмотра всех параметров

После того, как для каждого установленного параметра был вызван метод OnSetValue вы можете предпринять дополнительные действия для обработки параметров, которые не могли быть обработаны на этапе вызова OnSetValue

Аргументы:
[ses] текущая сессия
[data] данные фильтра
Returned: удобочитаемое представление параметров

virtual void Set ( Session &ses , const string &elid )

Данный метод является защищённым

Вызывается после закрытия формы кнопкой ОК

Вызывается после нажатия на ОК, в данный метод поступают значения всех полей; в данном методе можно реализовать сохранение данных.

Аргументы:
[inout] - ses Текущая сессия
See also: isp_api::Session
Аргументы:
[in] - elid Идентификатор элемента, для которого вызывается форма. Если пустая строка, то - новый элемент.

virtual void Get ( Session &ses , const string &elid )

Данный метод является защищённым

Вызывается перед показом формы

Вызывается перед отправкой данных формы на сторону клиента (и, соответственно, перед показом формы на экране) в данном методе можно реализовать заполнение полей формы некоторыми данными

Аргументы:
[inout] - ses Текущая сессия
See also: isp_api::Session
Аргументы:
[in] - elid Идентификатор элемента, для которого вызывается форма