Документация для разработчиков
Темная тема

Класс CWizardStep

Описание

Для каждого шага, добавляемого в мастер, создаётся экземпляр класса CWizardStep. В переопределяемых функциях (InitStep, ShowStep, OnPostFrom) шага методы класса CWizardStep доступны через переменную-псевдоним $this.

<?
class MyFirstStep extends CWizardStep
{
    function InitStep()
    {
        $this->SetTitle("Первый шаг мастера");
    }
}
?>

Список методов

Метод Описание С версии
GetErrors Метод возвращает массив ошибок шага.
GetStepID Метод возвращает ID шага.
GetSubTitle Метод возвращает подзаголовок шага.
GetTitle Метод возвращает заголовок шага.
GetWizard Метод возвращает ссылку на объект мастера. 9.5.0
InitStep Инициализация свойств шага: идентификатора (ID), заголовка, подзаголовка, кнопок перехода на следующие шаги и др.
IsAutoSubmit Метод возвращает значение флага автоматической отправки.
OnPostForm Позволяет проверить входные данные, вернуть ошибки, изменить текущий шаг, выполнить любые другие действия.
SaveFile Метод сохраняет файл в системе.
SetAutoSubmit Метод устанавливает флаг автоматической отправки в значение autoSubmit.
SetCancelCaption Метод устанавливает текстовую надпись caption кнопке Отмена.
SetCancelStep Метод определяет кнопку Отмена.
SetError Метод устанавливает ошибку шага с текстом strError и идентификатором id.
SetFinishCaption Метод устанавливает текстовую надпись caption кнопке Готово.
SetFinishStep Метод определяет кнопку Готово, ведущую на шаг stepID.
SetNextCaption Метод устанавливает текстовую надпись caption кнопке Далее.
SetNextStep Метод определяет кнопку Далее, ведущую на шаг stepID.
SetPrevCaptione Метод устанавливает текстовую надпись caption кнопке Назад.
SetPrevStep Метод определяет кнопку Назад, ведущую на шаг stepID.
SetStepID Метод устанавливает идентификатор stepID текущему шагу.
SetSubTitleМетод устанавливает подзаголовок шага.
SetTitleМетод устанавливает заголовок шага.
ShowCheckboxFieldМетод возвращает HTML-код переключателя с множественным вариантом выбора ответа.
ShowFileFieldМетод возвращает HTML-код поля для загрузки файла на сервер.
ShowHiddenFieldМетод возвращает HTML-код скрытого поля.
ShowInputFieldМетод возвращает HTML-код текстового поля.
ShowRadioFieldМетод возвращает HTML-код переключателя с единственным вариантом выбора ответа.
ShowSelectFieldМетод выводит HTML-код выпадающего списка с одиночным выбором.
ShowStep Определяет содержимое шага.


Пользовательские комментарии

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2020, «1С-Битрикс», 2020
Наверх