Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Include Protected Members
Include Inherited Members
Represents a group on a SharePoint Foundation Web site.
The SPGroup type exposes the following members.
Properties
Name | Description | |
---|---|---|
![]() |
AllowMembersEditMembership | Gets or sets a Boolean value that specifies whether group members can modify membership in the group. |
![]() |
AllowRequestToJoinLeave | Gets or sets a Boolean value that specifies whether to allow users to request membership in the group and to allow users to request to leave the group. |
![]() |
AutoAcceptRequestToJoinLeave | Gets or sets a Boolean value that specifies whether users are automatically added or removed when they make a request. |
![]() |
CanCurrentUserEditMembership | Gets a Boolean value that indicates whether the current user can modify membership of the group. |
![]() |
CanCurrentUserManageGroup | Gets a Boolean value that indicates whether the current user can manage the group. |
![]() |
CanCurrentUserViewMembership | Gets a Boolean value that indicates whether the current user can view the member list of the group. |
![]() |
ContainsCurrentUser | Gets a Boolean value that indicates whether the group contains the current user, included either through direct or indirect membership. |
![]() |
Description | Gets or sets the description for the group. |
![]() |
DistributionGroupAlias | Gets the distribution group alias that is associated with the group. |
![]() |
DistributionGroupEmail | Gets the email address of the distribution group. |
![]() |
DistributionGroupErrorMessage | Gets the most recent error message that was returned by an asynchronous distribution group operation. |
![]() |
DistributionGroupPendingJobData | Gets the type and identifier (ID) of the currently pending asynchronous Directory Management Service request. |
![]() |
ExplicitlyContainsCurrentUser | Gets a Boolean value that indicates whether the current user has been added explicitly as a direct member of the SharePoint Foundation group, as opposed to indirect membership through a directory group. |
![]() |
ID | Gets the identifier (ID) for the group. (Overrides SPPrincipal.ID.) |
![]() |
LoginName | Gets the login name of the group. (Overrides SPPrincipal.LoginName.) |
![]() |
Name | Gets or sets the name of the group. (Overrides SPPrincipal.Name.) |
![]() |
OnlyAllowMembersViewMembership | Gets or sets a Boolean value that specifies whether only group members are allowed to view the list of members in the group. |
![]() |
Owner | Gets or sets the owner for the group, which can be a user or another group. |
![]() |
ParentWeb | Gets the parent Web site for the principal. (Inherited from SPPrincipal.) |
![]() |
RequestToJoinLeaveEmailSetting | Gets or sets the e-mail address to which membership requests are sent. |
![]() |
Roles | Obsolete. Gets the collection of roles associated with the principal. (Inherited from SPPrincipal.) |
![]() |
Users | Gets a collection of user objects that represents all the users in the group. |
![]() |
Xml | Gets the properties of the group as an XML string. |
Top
Methods
Name | Description | |
---|---|---|
![]() |
AddUser(SPUser) | Adds the specified user to the group. |
![]() |
AddUser(String, String, String, String) | Adds the user who is specified by a particular user name, email address, display name, and notes to the group. |
![]() |
ClearDistributionGroupErrorMessage | Clears the distribution group error message. |
![]() |
CreateDistributionGroup | Creates a distribution list for the group. |
![]() |
DeleteDistributionGroup | Deletes the distribution list that is associated with the group. |
![]() |
Equals | (Inherited from Object.) |
![]() |
Finalize | (Inherited from Object.) |
![]() |
GetDistributionGroupArchives | Returns the lists that serve as archives for messages that are sent to the distribution lists for this group. |
![]() |
GetField | Reserved for internal use. (Inherited from SPPrincipal.) |
![]() |
GetHashCode | (Inherited from Object.) |
![]() |
GetType | (Inherited from Object.) |
![]() |
InitMember | Initializes the member. (Overrides SPPrincipal.InitMember().) |
![]() |
MemberwiseClone | (Inherited from Object.) |
![]() |
RemoveUser | Removes the specified user from the group. |
![]() |
RenameDistributionGroup | Renames the distribution list that is associated with the group. |
![]() |
ResynchronizeDistributionGroup | Updates the member list and properties of the distribution list that is associated with the group to match the current values of the group. |
![]() |
SetDistributionGroupArchives | Sets the lists that serve as distribution group archives for the group. |
![]() |
SetField | (Inherited from SPPrincipal.) |
![]() |
ToString | Returns the name of the group. (Overrides Object.ToString().) |
![]() |
Update | Updates the database with changes that have been made to the properties of the group. |
![]() |
UpdateDistributionGroupStatus | Queries the Directory Management Service for the status of a pending operation, if any, for the group's distribution list, and if an operation has just completed, resynchronizes data if necessary. |
Top
Fields
Name | Description | |
---|---|---|
![]() |
m_arrMembersData | Stores the member data as a two-dimensional array. (Inherited from SPPrincipal.) |
![]() |
m_bDataInitialized | Contains a Boolean value indicating whether the data is initialized. (Inherited from SPPrincipal.) |
![]() |
m_index | Contains the index into the m_arrMembersData array for the current member. (Inherited from SPPrincipal.) |
![]() |
m_web | Stores the Web site object. (Inherited from SPPrincipal.) |
Top