ICalendarDimension.ParamInUse

Syntax

ParamInUse(ParamIndex: Integer): Boolean;

Parameters

ParamIndex — index of calendar dictionary parameter.

Description

The ParamInUse property determines whether the dictionary parameter index of which is passed by the ParamIndex parameter is used to enter start or end date of calendar period.

Comments

The following values can be specified as an index:

0 - dictionary parameter indicating start of calendar period.
1 - dictionary parameter indicating end of calendar period.

To use a parameter to enter desired date, set value of respective index to True in this property. Parameters created in a calendar dictionary have the following IDs:

YEAR_START - dictionary parameter indicating start of calendar period.
YEAR_FINISH - dictionary parameter indicating end of calendar period.

Example

Executing the example assumes that the repository contains a calendar dictionary with the CALENDAR_DIM identifier.

Sub UserProc;
Var
    MB: IMetabase;
    MObj: IMetabaseObject;
    CalDim: ICalendarDimension;
Begin
    MB:=MetabaseClass.Active;
    MObj:=MB.ItemById("CALENDAR_DIM").Edit;
    CalDim:=MObj As ICalendarDimension;
    CalDim.ParamInUse(0):=True;
    MObj.Save;
End Sub UserProc;

After executing the example start date of calendar dictionary is set in dictionary parameters.