|
DataGroup |
|
The DataGroup subordinate object is used to define a data group to which a view or data source has been assigned. One object is defined for each assigned group. DataGroup corresponds to the pvxview.grp and pvxview.gpd files.
For information on the pvxview.grp and pvxview.gpd file structures, see Views System File Structures. Properties are read only and are set using corresponding Setxxx( ) methods.
The following table lists the properties of the DataGroup subordinate object:
|
Property |
Description |
|
DefaultGroup |
(Internal Use Only) Indicator (0/1) for default group (i.e. the group to which unassigned views and data sources are assigned). |
|
Description$ |
Data group description (used to identify the data group). |
|
InternalID$ |
Internal identifier for the data group. |
|
Members$ |
List of SEP-separated object identifiers for views and data sources that belong to the group. |
The following table lists the methods of the DataGroup subordinate object:
|
Method |
Description |
|
AddMember(ObjID) |
Add the specified view or data source object to the data group. Returns -1 if the object is already a member. |
|
ClearMembers( ) |
Clears all the members from the data group. |
|
FindMember(ObjID) |
Returns a Boolean value (0/1) indicating whether the data source or view represented by ObjID belongs in the group. |
|
RemoveMember(ObjID) |
Remove the specified view or data source object from the data group. Returns -1 if the object is not already a member. |
|
SetDefault(Flg) |
Set the group as the default when Flg =1. |
|
SetDescription(Description$) |
(Internal Use Only) Set the data group description used to identify the data group. Use ViewCtl equivalent. |
|
SetInternalID(InternalID$) |
(Internal Use Only) Set the internal identifier for the data group. |