ICalendarDimension

Сборка: Dimensions;

Пространство имен: Prognoz.Platform.Interop.Dimensions;

Описание

Интерфейс ICalendarDimension содержит свойства и методы календарного справочника.

Иерархия наследования

ICalendarDimension

Комментарии

При создании нового календарного справочника для его корректной работы необходимо произвести следующие минимальные настройки:

• В свойствах StartYear/EndYear зафиксировать годы начала/окончания календаря или в свойствах StartYearAsParam/EndYearAsParam указать признак использования параметров для указания начала/окончания календаря.

• Используя различные свойства Include*, задать список уровней, которые будут присутствовать в календаре.

Свойства

	Имя свойства	Краткое описание
	AllowedBlock	Свойство AllowedBlock возвращает True, если уровень может использоваться в качестве блока в календарном справочнике.
	AllowedHierarchy	Свойство AllowedHierarchy возвращает True, если указанный тип иерархии может использоваться в календарном справочнике.
	AllowedLevel	Свойство AllowedLevel возвращает True, если указанный уровень может использоваться в календарном справочнике.
	AllowedNameFormat	Свойство AllowedNameFormat возвращает True, если формат наименования может использоваться при изменении формата отображения элементов блока в календарном справочнике.
	AllowedParam	Свойство AllowedParam возвращает True, если параметр может использоваться в календарном справочнике.
	AttributeCount	Свойство AttributeCount возвращает количество системных атрибутов справочника.
	AttributeIndex	Свойство AttributeIndex возвращает индекс стандартного атрибута, отображаемого при построении справочника.
	AttributeNameFormat	Свойство AttributeNameFormat определяет формат отображения наименования элементов указанного блока календаря.
	Attributes	Свойство Attributes возвращает коллекцию пользовательских атрибутов календарного справочника.
	BlockInUse	Свойство BlockInUse определяет, используется ли блок уровня при построении справочника.
	CalendarLevelIndex	Свойство CalendarLevelIndex возвращает индекс для указанного уровня календаря.
	DefaultOpenType	Свойство DefaultOpenType определяет вид элементов, который используется по умолчанию при открытии календаря.
	EndYear	Свойство EndYear определяет фиксированный год окончания календарного справочника.
	EndYearAsParam	Свойство EndYearAsParam определяет состояние опции «Не фиксировать окончание (определить как параметр справочника)».
	Hierarchy	Свойство Hierarchy определяет тип иерархии календаря.
	HierarchyCorrection	Свойство HierarchyCorrection определяет состояние опции «Коррекция иерархии».
	IncludeDays	Свойство IncludeDays определяет, будет ли присутствовать уровень «Дни» в календарном справочнике.
	IncludeHalfYears	Свойство IncludeHalfYears определяет, будет ли присутствовать уровень «Полугодия» в календарном справочнике.
	IncludeMonths	Свойство IncludeMonths определяет, будет ли присутствовать уровень «Месяцы» в календарном справочнике.
	IncludeQuarters	Свойство IncludeQuarters определяет, будет ли присутствовать уровень «Кварталы» в календарном справочнике.
	IncludeWeek	Свойство IncludeWeek определяет, будет ли присутствовать уровень «Недели» в календарном справочнике.
	IncludeYears	Свойство IncludeYears определяет, будет ли присутствовать уровень «Годы» в календарном справочнике.
	IsDateEnd	Свойство IsDateEnd определяет, заменять ли дату начала периода датой конца периода для указанного уровня календаря.
	LastLevelNameAsDay	Свойство LastLevelNameAsDay определяет состояние опции «Замена наименования последнего уровня на день».
	LevelCount	Свойство LevelCount возвращает количество уровней в календарном справочнике.
	LevelIndex	Свойство LevelIndex возвращает индекс уровня по номеру в структуре календарного справочника.
	LevelInUse	Свойство LevelInUse определяет, используется ли уровень при построении справочника.
	NameAttrFormat	Свойство NameAttrFormat определяет формат представления наименования элементов указанного уровня.
	OffsetDate	Свойство OffsetDate определяет число дней, на которые будет смещена дата начала указанного уровня.
	ParamInUse	Свойство ParamInUse определяет, используется ли параметр справочника, индекс которого передается посредством параметра ParamIndex, для ввода начала или окончания периода календаря.
	ReverseOrder	Свойство ReverseOrder определяет состояние опции «Обратный порядок элементов в справочнике».
	Setup	Свойство Setup параметры календаря, элементы которого были построены динамически.
	ShiftForward	Свойство ShiftForward определяет состояние опции «Сдвиг последнего уровня на точку вперед».
	StartYear	Свойство StartYear определяет фиксированный год начала календарного справочника.
	StartYearAsParam	Свойство StartYearAsParam определяет состояние опции «Не фиксировать начало календаря (определить как параметр справочника)».
	WeekLevel	Свойство WeekLevel определяет параметры уровня «Недели» в календарном справочнике.

Методы

	Имя метода	Краткое описание
	AddAttribute	Метод AddAttribute осуществляет добавление стандартного атрибута в список атрибутов, присутствующих при построении календарного справочника.
	AssignAttributesFormats	Метод AssignAttributesFormats копирует форматы представления атрибутов из указанного календарного справочника.
	CompareLevels	Метод CompareLevels используется для определения результата сравнения уровней календаря.
	DateFromWeek	Метод DateFromWeek осуществляет расчет даты, соответствующей указанному дню.
	OpenAs	Метод OpenAs открывает календарь в указанном виде.
	RemoveAttribute	Метод RemoveAttribute осуществляет удаление стандартного атрибута из списка атрибутов, присутствующих при построении календарного справочника.
	WeekFromDate	Метод WeekFromDate осуществляет расчет параметров дня, соответствующего указанной дате.

См. также:

Интерфейсы сборки Dimensions