MODLISTSETTINGS Method

Applies to: SharePoint Foundation 2010

Changes the properties of a SharePoint list.

<Method ID="Text">
  <SetList Scope="Request">GUID</SetList>
  <SetVar Name="Cmd">MODLISTSETTINGS</SetVar>
  <SetVar Name="OldListTitle">Text</SetVar>
  <SetVar Name="NewListTitle">Text</SetVar>
  <SetVar Name="Description">Text</SetVar>
  <SetVar Name="ReadSecurity">[1|2]</SetVar>
  <SetVar Name="WriteSecurity">[1|2|4]</SetVar>
  <SetVar Name="owshiddenversion">Integer</SetVar>
  <SetVar Name="displayOnLeft">[TRUE|FALSE]</SetVar>
  <SetVar Name="DisableAttachments">[1|2]</SetVar>
  <SetVar Name="Direction">[1|2|anything]</SetVar>
  <SetVar Name="Moderated">[TRUE|FALSE]</SetVar>
  <SetVar Name="HiddenList">[TRUE|FALSE]</SetVar>
  <SetVar Name="GlobalMtgDataList">[TRUE|FALSE]</SetVar>
  <SetVar Name="VersioningEnabled">[TRUE|FALSE]</SetVar>
  <SetVar Name="NewListTemplate">Text</SetVar>
  <SetVar Name="showUsernames">[on|off]</SetVar>
  <SetVar Name="AllowMultiVote">[on|off]</SetVar>
  <SetVar Name="EnableAssignToEmail">[0|1]</SetVar>
</Method>

Parameters

Parameter

Description

ID = "Text"

Application-specific string. In an HTML editor compatible with Microsoft SharePoint Foundation, such as Microsoft SharePoint Designer 2010, the string provides the sequence number and name of the method.

Scope = "Request"

When set to Request, the Scope attribute sets the variable for the scope of the enclosing Method element, unless the variable is changed by another tag.

Name = "Cmd"

Must be set to MODLISTSETTINGS.

Name = "Old_Title"

The previous title of the list.

Name = "New_Title"

The new title of the list.

Name = "Description"

The new text describing the list.

Name = "ReadSecurity"

Sets the security level for viewing items in the list. Possible values include the following.

  • 1   Users can read all items

  • 2   Users can read items only they created.

Name = "WriteSecurity"

Sets the security level for editing items in the list. Possible values include the following.

  • 1   Users can edit all items.

  • 2   Users can edit items only they created.

  • 4   Users cannot modify any list item.

Name = "owshiddenversion"

This is the current version number of the list. The MODLISTSETTINGS command works only if SharePoint Foundation and the client program agree on the version number of the list. This ensures that only one user at a time can modify the list schema.

Name = "displayOnLeft "

Optional. TRUE to display the list on Quick Launch.

Name = "DisableAttachments "

Optional 1 or 2. 2 to specify that items in the list cannot have attachments.

Name = "Direction"

Optional. Specifies the direction in which text is displayed in the list. Possible values include the following.

  • 1   Left-to-right

  • 2   Right-to-left

  • anything   None

Name = "Moderated"

Optional. TRUE to enable content approval for the list.

Name = "HiddenList "

Optional. TRUE to make the list hidden.

Name = "GlobalMtgDataList"

Optional. For a list in a Meeting Workspace site, TRUE to specify that the list is a series list or FALSE to specify a normal list.

Name = "VersioningEnabled"

Optional. TRUE to enable versioning for a document library.

Name = "NewListTemplate"

Optional. Specifies the relative path to the document template for a document library.

Name = "showUsernames"

Optional on or off. on to specify that the user name be displayed in the results of a survey.

Name = "AllowMultiVote"

Optional on or off. on to allow users to vote more than once in a survey.

Name = "EnableAssignToEmail "

Optional 0 or 1. 1 to enable e-mail notification of ownership for list items in an issue list.

Decoded

<Method ID="0,MODLISTSETTINGS">
  <SetList Scope="Request">GUID</SetList>
  <SetVar Name="Cmd">MODLISTSETTINGS</SetVar>
  <SetVar Name="OldListTitle">Old_Title</SetVar>
  <SetVar Name="NewListTitle">New_Title</SetVar>
  <SetVar Name="Description">Description</SetVar>
  <SetVar Name="ReadSecurity">1</SetVar>
  <SetVar Name="WriteSecurity">2</SetVar>
  <SetVar Name="owshiddenversion">9</SetVar>
</Method>