Bitrix Site Manager

CFormField

The CFormField is the class used with questions and fields.

Fields

Field Type Description
ID int The ID of the question or the field.
SID varchar(50) The symbolic identifier of the question or the field.
FORM_ID int The ID of the web form to which the question or field is bound.
TIMESTAMP_X datetime The time the parameters of the question or field were last modified.
ACTIVE char Active state flag (Y|N).
ADDITIONAL char If "Y", this record is a field. If "N", the record is a web form question.
FIELD_TYPE varchar(50) Type of the field. The following values are possible:
  • text - text;
  • integer - number;
  • date - date.
TITLE varchar(2000) Text of the question or the field title.
TITLE_TYPE varchar(4) Type of the question ("text" or "html")
IMAGE_ID int The question image.
C_SORT int Sort index.
REQUIRED char Flag specifying the question must be answered when creating a new result or modifying the existing one (Y|N).
IN_FILTER char Specifies the question or field is included in the result filter.
FILTER_TITLE varchar(2000) Filter field title.
IN_RESULTS_TABLE char If "Y", the value of the question or field is included in the HTML table of results.
IN_EXCEL_TABLE char If "Y", the value of the question or field is included in the Excel table of results.
RESULTS_TABLE_TITLE varchar(2000) Title of the result table column.
COMMENTS varchar(2000) Administrative comments for the question or field.

Methods

Method Description
Set Adds a new question or a field or modifies the existing one.
GetList Returns a list of questions or fields.
GetByID Returns the parameters of a question or a field by their ID.
GetBySID Returns the parameters of a question or a field by the symbolic identifier.
Copy Copies a question or a field.
Reset Deletes all answers of the specified question or field results.
Delete Deletes a question or a field and all its answers.