Просмотр кода страницы Руководство по настройке altAwin:Дополнительные поля

Справочник {{ClsMnu|Дополнительные поля|index=дополнительные поля}} содержит перечень дополнительных полей, определяемых для некоторых классов документов. Дополнительные поля могут определяться как для конечных типов документов, так и для абстрактных типов, от которых наследуются конечные. При определении дополнительных полей в базовом типе, они будут доступны также и во всех типах, которые от него наследуются. 

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

Возможность создания дополнительных полей как для конечных типов, так и для их родительских типов создаёт условия для потенциального конфликта при совпадениии идентификаторов дополнительных полей родительского и конечного типов. Если это происходит, приоритет отдаётся дополнительному полю, определённому для родительского типа.

В таблице представления отображаются записи дополнительных полей, соответствующие выбранному типу документа в дереве. Порядок следования записей дополнительных полей в таблице учитывается при построении форм, содержащих эти доп. поля документов, а также при упорядочивании колонок таблиц их представлений.

{{Tblcap|1=Панель инструментов представления {{ClsMnu|Дополнительные поля}} }}

{| class = "wikitable" 10:25:65-long
!Кнопка!!Команда!!Действие
|-
|{{Icon|AWButtonMoveUp.png}}|| Вверх || Перемещение выбранного элемента вверх в таблице 
|-
|{{Icon|AWButtonMoveDown.png}}|| Вниз || Перемещение выбранного элемента вниз в таблице
|-
| || Исправление значений || Исправление значений перечислений
|-
| || Обновление заголовков || Обновление заголовков документов
|-
| || Перезагрузать || Перезагрузка кеша дополнительных полей (см. ниже)
|}

Для создания нового элемента справочника выберете требуемый тип документа в дереве навигации и воспользуйтесь командой {{ClsMnu|Создать}} панели инструментов или контекстного меню. В отобразившемся окне {{ClsMnu|Дополнительное поле}} на вкладке {{ClsMnu|Общие данные}} задайте требуемые параметры создаваемого дополнительного поля:

{{DlgField|Идентификатор|идентификатор поля, обязательное значение;}}
{{DlgField|Наименование|обязательное поле, определяющее название создаваемого поля, отражающее его смысл; наименование отображается на форме документов и в таблице представления;}}
{{DlgField|Класс документа|автоматически заполняемое поле в зависимости от выбранного раздела в дереве навигации; класс документа определяет, для каких документов создаётся дополнительное поле;}}
{{DlgField|Тип поля|обязательное поле, определяющее тип создаваемого поля; может принимать одно из следующих значений:}}
{{DlgField1|Строка}}
{{DlgField1|Целое число}}
{{DlgField1|Вещественное число}}
{{DlgField1|Булево| флаговый переключатель; в поле {{ClsMnu|метка}} задаётся текстовая метка для флага. }}
{{DlgField1|Дата}}
{{DlgField1|Дата/время}}
{{DlgField1|Документ|произвольный документ altAwin, тип документа выбирается из числа типов, зарегистрированных в приложении.}}
{{DlgField1|Текст}}
{{DlgField1|Перечисление|значение доп. поля может принимать один из вариантов, указанных на вкладке {{ClsMnu|Значения}}; в формах документов поля данного типа отображаются в виде выпадающего списка.}}
{{DlgField1|Множество|значение доп. поля может принимать один или несколько из вариантов, указанных на вкладке {{ClsMnu|Значения}}; в формах документов поля данного типа отображаются в виде группы чекбоксов.}}
{{DlgField|Вычисляемое: Значение вычисляемо|флаговый переключатель, определяющий, что значение дополнительного поля недоступно для модификации посредством пользовательского ввода и вычисляется при помощи скрипта вычисления; вычисляемые поля существуют в режиме «только для чтения» и не предназначены для непосредственной модификации;}}
{{DlgField|Обязательный: Значение обязательно для заполнения|флаговый переключатель, определяющий обязательность заполнения этого поля при создании соответствующего документа;}}
{{DlgField|Дублируется: Значение будет скопировано при дублировании|переключатель, определяющий поведение значения поля при дублировании содержащих его документов. Если флаг {{ClsMnu|Дублируется}} снят, при дублировании документа с данным полем, его значение будет инициализировано значением по умолчанию.}}
{{DlgField|Значение по умолчанию|значене дополнительного поля, устанавливаемое автоматически в момент создания содержащего его документа}};
{{DlgField|Скрипт проверки|скрипт, срабатывающий перед применением нового значения к данному дополнительному полю при изменении содержащего его документа}};
{{DlgField|Скрипт изменения|скрипт, срабатывающий после применением нового значения к данному дополнительному полю при изменении содержащего его документа}};
{{DlgField|Видимость|переключатель, определяющий, где следует показывать поле: в форме редактирования документа ({{ClsMnu|Форма}}), в таблице документов соответствующего представления ({{ClsMnu|Таблица}}); используется для организации фильтрации и сортировки записей в таблице;}}
{{DlgField|Экспорт: Разрешён экспорт дилеру|флаговый переключатель, определяющий, будет ли данное дополнительное поле передаваться в удалённый офис и дилерам с настройкам;}}
{{DlgField|Комментарий|текстовый комментарий}}
{{DlgField|Скрипт вычисления|скрипт для вычисления значения вычисляемого поля, срабатывающий при изменении полей содержащего его документа; поле доступно при установке флага {{ClsMnu|Значение вычисляемо}}}};

{{Picture|newadditionalfield.png|title=Окно документа {{ClsMnu|Дополнительное поле}}|num=4.174|id=910}}

Для дополнительных полей существует возможность управления разграничением доступа для различных пользователей и подразделений. Разграничение доступа к дополнительным полям реализуется путём заполнения списков, расположенных на вкладках {{ClsMnu|Доступ для чтения}} и {{ClsMnu|Доступ для записи}}. При определении параметров доступа к дополнительным полям применяются следующие правила:
* Поле доступно для записи пользователю, если оба списка пусты или пользователь (его подразделение) добавлен в список {{ClsMnu|Доступ для записи}}.
* Поле доступно для чтения пользователю, если оба списка пусты или пользователь (его подразделение) определён в одном из них.
* Поле не доступно, если пользователь (его подразделение) не определён ни в одном из списков, а хотя бы один список не пуст.

Определённые дополнительные поля, доступные для текущего пользователя, отображаются на главной закладке формы документа ниже всех прочих стандартных полей.

{{Warning|Обратите внимание, что оптимальное количество дополнительных полей для одного документа не должно превышать 20-25. Определение более 30 дополнительных полей может резко замедлить работу программы и существенно увеличить риск потери или повреждения данных.}}

=== Перезагрузка дополнительных полей ===
Для обновления кеша дополнительных полей после внесения изменений следует воспользоваться кнопкой {{ClsMnu|Перезагрузить}}, расположенной на панели инструментов представления. Перезагрузка дополнительных полей предназначена для применения изменений без необходимости перезапуска приложения.

=== Доступ к значениям дополнительных полей в скриптах ===
Для многих документов имеется возможность доступа к дополнительным полям из скриптов. Например, создавая доп. поле с идентификатором {{ClsKbrd|Test}} к документу типа {{ifn|IdocExecutor}}, доступ к нему в скрипте обеспечивается через свойство с таким же именем:
<syntaxhighlight lang="pascal">var
  D: IdocExecutor;
begin
  D := OpenDocument(IdocExecutor, 1);
  D.Test := "123" ;
  D.PropertyByName['Test'] := "321";
end;</syntaxhighlight>

Значения дополнительных полей типа {{ClsMnu|Множество}} хранятся в виде текстовой строки, представленной элементами множества, разделёнными запятой.

Для разделения значений дополнительного поля типа {{ClsMnu|Множество}} можно поступать следующим образом:
<syntaxhighlight lang="pascal">var
  Strings: TStrings;
begin
  Strings := TStringList.Create;
  try
    Strings.Delimiter := ',';
    Strings.DelimitedText := AValue; //значение доп. поля
 
    for I := 0 to Strings.Count — 1 do
    begin
      // тут чего-то делаем
    end;
  finally
    Strings.Free;
  end;
end;</syntaxhighlight>

=== Проверка значений при изменении ===
{{ClsMnu|Скрипт проверки}} срабатывает до применения нового значения, в контексте доступны переменные:
{{DlgField|''Instance''|экземпляр сущности, в которой происходят изменения, должна находиться в режиме «только для чтения»}};
{{DlgField|''OldValue''|предыдущее значение}};
{{DlgField|''NewValue''|применяемое значение}};
{{DlgField|''Result''|результирующее значение, которое на старте равно ''NewValue''}}.

В результате отработки скрипта в поле запишется значение из переменной {{ClsKbrd|Result}}.

{{ClsMnu|Скрипт изменения}} срабатывает после применения нового значения, в контексте доступны переменные:
{{DlgField|''Instance''|экземпляр сущности, в которой происходят изменения}};
{{DlgField|''OldValue''|предыдущее значение}}.


=== Использование дополнительных полей в калькуляции ===
<span class="Index">Калькуляция: дополнительные поля</span>Существует возможность использования дополнительных полей заказчика и продавца в калькуляции трудоёмкостей и стоимостей. Эти возможности реализуются посредством следующих функций:
* <source lang = "pascal">GetCustomerParameter(Name: string): Variant</source> — возвращает дополнительное поле заказчика. Тип возвращаемого значения зависит от типа поля. Для перечислимых типов возвращается строка.
* <source lang = "pascal">GetSellerParameter(Name: string): Variant</source> — возвращает дополнительное поле продавца. Тип возвращаемого значения зависит от типа поля. Для перечислимых типов возвращается строка.
* <source lang = "pascal">GetCustomerParameterUnit(Name: string): string</source> — возвращает имя единицы измерения для дополнительного поля заказчика.
* <source lang = "pascal">GetSellerParameterUnit(Name: string): string</source> — возвращает имя единицы измерения для дополнительного поля продавца.

Например, у заказчика создано доп. поле типа "цвет" с идентификатором "Color", тогда в калькуляции можно использовать, такую конструкцию:
<syntaxhighlight lang="pascal">if TypeID(GetCustomerParameter('Color')) <> 'Null' then
  Trace(GetCustomerParameter('Color').Title);</syntaxhighlight>

<noinclude>{{Навигация|Пользовательские действия|Раздел «Расширения»|Пользовательские документы}}</noinclude>