company logo

ControlContext :: removeRegion - Remove region and columns

The function throws an exception, when the region is not valid.

Implementation details

ControlContext  :: removeRegion ( int64 iRegionID, bool bRemoveColumns )

The function allows removing a region from a tree or list view. The region with the identifier passed in iRegionID will be removed from the list schema. In order to remove all regions for the control, 0 might be passed in iRegionID.

In order to remove only columns from the region definition, true has to be passed in bRemoveColumns.

After changing a list definition by removing columns or regions, the region has to be refreshed by calling refresh().

  • iRegionID - Region identification

    The region identifier is either the resource identity for the region definition (in case the region has been created from an external resource defined in a resource database) or the internal column identifier returned from the ControlContext::addRegion() function.

  • bRemoveColumns - Remove columns

    In order to remove columns from the region definition, this options has to be set to true.