Bitrix Site Manager

CFormStatus

The CFormStatus class is used with statuses.

Fields

Field Type Description
ID int The status ID.
FORM_ID int The web form ID.
TIMESTAMP_X datetime The time the parameters of the status were last modified.
ACTIVE char Active state flag [Y|N].
C_SORT int Status sort weight.
TITLE varchar(255) Status title.
DESCRIPTION varchar(2000) Status description.
DEFAULT_VALUE char Flag indicating the result status is default [Y|N].
CSS varchar(255) Name of the CSS class to display the status title.
HANDLER_OUT varchar(255) Path relative to the root to the handler called when changing this result status to another.
HANDLER_IN varchar(255) Path relative to the root to the handler called when changing a result status to this.

Methods

Method Description
Set Adds a new status or modifies the existing one.
GetList Returns a list of statuses of the specified web form.
GetByID Returns the parameters of a status.
Copy Copies a status.
Delete Deletes a status.
GetPermissions Returns an array of the current user permissions for the specified status.
GetPermissionList Returns arrays containing user groups that have the specified permissions for the specified status.
GetDropdown Returns a list of statuses in the format suitable to display a single selection drop-down list.