Получить закрепленные колонки Options::getStickedColumns

Модуль: main — подключать отдельно не нужно

Метод Options::getStickedColumns возвращает закрепленные колонки текущего представления грида.

Сигнатура метода в классе Bitrix\Main\Grid\Options:

public function getStickedColumns()

Возвращаемое значение

Метод возвращает массив идентификаторов колонок или null, если в текущем представлении закрепленных колонок нет.

Особенности

Метод setStickedColumns записывает колонки в представление default. Если текущее представление другое, метод не вернет эти колонки.

Примеры

Пример. Код проверяет, закреплены ли колонки:

<?php
use Bitrix\Main\Grid\Options;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

$columns = (new Options('units_grid'))->getStickedColumns();

echo $columns === null ? 'no sticked columns' : implode(',', $columns);

Для грида без сохраненных настроек код выведет no sticked columns.

Смотрите также