SetOrgByPeriodFilteringInfo

For Organization by Period applications, specifies whether active entities are filtered for display on the grid. If filtering is enabled, SetOrgByPeriodFilteringInfo also specifies the filtering criteria.

SetOrgByPeriodFilteringInfo has no effect for non-Organization by Period applications. Note that the HFMwMetadata component’s isOrgByPeriod property indicates whether an application is an Organization by Period application.

Tip:	The filtering criteria arguments take dimension member IDs. To return a member’s ID from its label, pass the label to HFMwDimension.GetMemberID.

Syntax

<HFMwDataGrid>.SetOrgByPeriodFilteringInfo varbEnableFiltering, lOBPScenarioMemberID, lOBPYearMemberID, lOBPPeriodMemberID

Argument	Description
varbEnableFiltering	Specifies whether filtering is enabled. Pass TRUE to enable filtering, FALSE to disable filtering. Input argument.
lOBPScenarioMemberID	The member ID of the Scenario dimension member to filter by. Input argument. Long subtype.
lOBPYearMemberID	The member ID of the Year dimension member by which to filter. Input argument. Long subtype.
lOBPPeriodMemberID	The member ID of the Period dimension member by which to filter. Input argument. Long subtype.