company logo

Region :: removeRegion - Remove subregion and columns from region definition

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().

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

Implementation overview

Implementation details

  1. Remove subregion and columns from region definition
    Region  :: removeRegion ( bool bRemoveColumns )

    The function allows removing a sub region from a region in a tree or list view. The region will be removed from the list schema.

    • bRemoveColumns - Remove columns

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

  2. to list
  3. Remove subregion by region ID
    Region  :: removeRegion ( int64 iRegionID, bool bRemoveColumns )
    • 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.

  4. to list
  5. Remove subregion by resource name
    Region  :: removeRegion ( odaba::String &sName, bool bRemoveColumns )
    • sName - Resource or entity name

      The name refers to a design or GUI resource.

    • bRemoveColumns - Remove columns

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

  6. to list