Разработка > Программный код

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

Особенности использования:

•константы добавляются в программный код решений, модулей, типов сущностей и отчетов. При этом константы можно будет использовать только в рамках того модуля, в котором они созданы. Константы, созданные в решении, можно использовать только в коде решения и его перекрытиях;

•если константу необходимо использовать в других решениях или модулях, то при добавлении константы указывается атрибут Public;

•константы нельзя переопределять или наследовать;

•в качестве констант можно указывать только:

•простые типы:

short, short?	Guid, Guid?	double, double?
int, int?	bool, bool?	Uri
long, long?	decimal, decimal?	string
char, char?	DateTime, DateTime?

При объявлении константы указывается модификатор const;

•идентификаторы (Guid). При объявлении константы указывается static readonly Guid.

Чтобы добавить константу:

1.В редакторе решения, модуля, типа сущности или отчета в группе «Структуры и константы» перейдите по ссылке Добавить.

2.В открывшемся редакторе кода доработайте имя константы, тип и допишите комментарии:

/// <summary>
// Имя типа прав "Регистрация".
/// </summary>
public const string RegistrationRightType = "Регистрация";
 
[Public]
/// <summary>
// GUID роли "Руководители наших организаций".
/// </summary>
public static readonly Guid BusinessUnitHeadsRole = Guid.Parse("03C7A126-83DE-4F8F-908B-3ACB868E30C5");

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

ПОДРОБНЕЕ

Например, все константы с именами типов прав можно сгруппировать в класс TypeRights, а константы с именами ролей – в класс Role:

public static class Module
{
  public static class TypeRights
  {
    // Имя типа прав "Регистрация".
    public const string RegistrationRightType = "Регистрация";
    // Имя типа прав "Удаление".
    public const string DeleteRightType = "Удаление";
  }
  public static class Role
  {
    // Имя роли "Делопроизводители".
    public const string RoleNameClerks = "Делопроизводители";
    // Имя роли "Ответственные за настройку регистрации".
    public const string RoleNameRegistrationManagers = "Ответственные за настройку регистрации";
  }
}

3.Сохраните изменения.

4.Перейдите в программный код, в котором будет использоваться константа. Для обращения к константам используются следующие форматы:

•Constants.Module.<Имя константы> – для констант модуля или решения;

•Constants.<Имя перекрытого модуля>.Module.<Имя константы> – для констант перекрытого модуля;

•Constants.<Имя перекрытого модуля>.<Имя перекрытого типа сущности>.<Имя константы> – для констант перекрытого типа сущности;

•Constants.<Имя типа сущности>.<Имя константы> – для констант типов сущностей;

•Constants.Report.<Имя константы> – для констант отчетов;

•<Имя модуля или решения>.PublicConstants.Module.<Имя константы> – для констант, доступных в других модулях или решениях;

•<Имя модуля>.PublicConstants.<Имя типа сущности>.<Имя константы> – для констант типов сущностей, доступных в других модулях.

важно. Если константы сгруппированы в классы, то в формат перед именем константы добавляется имя класса.

Формат обращения к константе класса TypeRights (см. пример выше) выглядит следующим образом: Constants.Module.TypeRights.RegistrationRightType

В модуль «Делопроизводство» добавлена константа для фиксирования срока рассмотрения документа в днях.

// Срок рассмотрения документа по умолчанию в днях.
public const int DocumentReviewDefaultDays = 3;

Используем добавленную константу в серверной функции:

/// <summary>
/// Получить константу срока рассмотрения документа по умолчанию в днях.
/// </summary>
/// <returns> Константа срока рассмотрения документа по умолчанию в днях.</returns>
[Remote]
public virtual int GetDocumentReviewDefaultDays()
{
  return Constants.Module.DocumentReviewDefaultDays;
}

СМ. ТАКЖЕ