SPGroup members
Collapse the table of content
Expand the table of content

SPGroup members

Represents a group on a SharePoint Foundation Web site.

The SPGroup type exposes the following members.

  Name Description
Public property AllowMembersEditMembership Gets or sets a Boolean value that specifies whether group members can modify membership in the group.
Public property 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.
Public property AutoAcceptRequestToJoinLeave Gets or sets a Boolean value that specifies whether users are automatically added or removed when they make a request.
Public property CanCurrentUserEditMembership Gets a Boolean value that indicates whether the current user can modify membership of the group.
Public property CanCurrentUserManageGroup Gets a Boolean value that indicates whether the current user can manage the group.
Public property CanCurrentUserViewMembership Gets a Boolean value that indicates whether the current user can view the member list of the group.
Public property ContainsCurrentUser Gets a Boolean value that indicates whether the group contains the current user, included either through direct or indirect membership.
Public property Description Gets or sets the description for the group.
Public property DistributionGroupAlias Gets the distribution group alias that is associated with the group.
Public property DistributionGroupEmail Gets the email address of the distribution group.
Public property DistributionGroupErrorMessage Gets the most recent error message that was returned by an asynchronous distribution group operation.
Public property DistributionGroupPendingJobData Gets the type and identifier (ID) of the currently pending asynchronous Directory Management Service request.
Public property 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.
Public property ID Gets the identifier (ID) for the group. (Overrides SPPrincipal.ID.)
Public property IsHiddenInUI Gets a value that indicates whether this member should be hidden in the UI. (Inherited from SPPrincipal.)
Public property LoginName Gets the login name of the group. (Overrides SPPrincipal.LoginName.)
Public property Name Gets or sets the name of the group. (Overrides SPPrincipal.Name.)
Public property OnlyAllowMembersViewMembership Gets or sets a Boolean value that specifies whether only group members are allowed to view the list of members in the group.
Public property Owner Gets or sets the owner for the group, which can be a user or another group.
Public property ParentWeb Gets the parent Web site for the principal. (Inherited from SPPrincipal.)
Public property RequestToJoinLeaveEmailSetting Gets or sets the e-mail address to which membership requests are sent.
Public property Roles Obsolete. Gets the collection of roles associated with the principal. (Inherited from SPPrincipal.)
Public property Users Gets a collection of user objects that represents all the users in the group.
Public property Xml Gets the properties of the group as an XML string.
Top

  Name Description
Public method AddUser(SPUser) Adds the specified user to the group.
Public method 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.
Public method ClearDistributionGroupErrorMessage Clears the distribution group error message.
Public method CreateDistributionGroup Creates a distribution list for the group.
Public method DeleteDistributionGroup Deletes the distribution list that is associated with the group.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetDistributionGroupArchives Returns the lists that serve as archives for messages that are sent to the distribution lists for this group.
Protected method GetField Reserved for internal use. (Inherited from SPPrincipal.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method InitMember Initializes the member. (Overrides SPPrincipal.InitMember().)
Protected method MemberwiseClone (Inherited from Object.)
Public method RemoveUser Removes the specified user from the group.
Public method RenameDistributionGroup Renames the distribution list that is associated with the group.
Public method 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.
Public method SetDistributionGroupArchives Sets the lists that serve as distribution group archives for the group.
Protected method SetField Sets the field for the user or group. (Inherited from SPPrincipal.)
Public method ToString Returns the name of the group. (Overrides Object.ToString().)
Public method Update Updates the database with changes that have been made to the properties of the group.
Public method 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

  Name Description
Protected field m_arrMembersData Stores the member data as a two-dimensional array. (Inherited from SPPrincipal.)
Protected field m_bDataInitialized Contains a Boolean value indicating whether the data is initialized. (Inherited from SPPrincipal.)
Protected field m_index Contains the index into the m_arrMembersData array for the current member. (Inherited from SPPrincipal.)
Protected field m_web Stores the Web site object. (Inherited from SPPrincipal.)
Top
Show:
© 2016 Microsoft