SP. Список object (sp.js)

Статья
02/03/2016

Представляет список на веб-сайте SharePoint.

Дата последнего изменения: 9 марта 2015 г.

Область применения: apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013

Содержание
Элементы
Замечания
Конечная точка ресурса REST

var object = new SP.List()

Элементы

Объект List содержит следующие элементы.

Конструктор

Объект List имеет следующий конструктор.

Конструктор	Описание
Список	Инициализирует новый экземпляр объекта SP.List.

Методы

Объект List содержит следующие методы.

Метод	Описание
addItem	Получает значение, указывающее, идет ли текст в меню слева направо.
deleteObject	reservemember
getChanges	Задает шаблон списка.
getItemById	Получает или задает значение, указывающее, включены ли в запрос общие изменения элементов списка.
getItems	Удаляет список.
getListItemChangesSinceToken
getRelatedFields	Получает значение, задающее этап элемента корзины.Возвращает коллекцию полей подстановки, использующих данный список как источник данных, у которых FieldLookup.IsRelationship равняется.
getRelatedFieldsExtendedData	Инициализирует новый экземпляр объекта SP.RegionalSettings.
getUserEffectivePermissions
getView	Этот класс является замещающим для всех способов обмена документами.
Корзина	Получает определение роли, связанное с определенным значением перечисления Role.
renderListData
renderListFormData
reserveListItemId
saveAsNewView
обновление	Получает или задает содержимое файла в виде потока.

Properties

Объект List имеет следующие свойства.

Свойство	Описание
allowContentTypes	Получает значение, указывающее, поддерживает ли список типы контента.
baseTemplate	Получает файл по указанному индексу в коллекции.
baseType	Получает базовый тип списка.
browserFileHandling	Параметры для изменения запросаBrowserFileHandlingBrowserFileHandling
contentTypes	Получает определение роли по указанному индексу в коллекции.
contentTypesEnabled	Изменение списка.
создан	Получает значение, задающее время создания списка.
dataSource	Удаляет поле с указанным внутренним именем из коллекции.Получает или задает тип календаря, используемый на сервере.Получает источник данных, связанный со списком, или
defaultContentApprovalWorkflowId	Инициализирует новый экземпляр объекта SP.ListDataSource.
defaultDisplayFormUrl	Получает базовый URL-адрес удаленной системы, развернутой во время установки данного экземпляра приложения.
defaultEditFormUrl	Добавляет файл-призрак в существующий список или библиотеку документов.
defaultNewFormUrl	Получает или задает значение, указывающее расположение новой формы по умолчанию для списка.
defaultView
defaultViewUrl	Очищает все разрешения для текущего экземпляра.
Описание	Получает или задает значение, указывающее описание списка.
Направление	Получает или задает значение, указывающее порядок чтения списка.
documentTemplateUrl	Получает или задает значение, задающее зависящий от сервера URL-адрес шаблона документа для списка.
draftVersionVisibility	Получает или задает значение, указывающее минимальное разрешение для просмотра дополнительных номеров версий и черновиков в списке.
effectiveBasePermissions	Получает значение, которое указывает действующие разрешения для списка, назначенные текущему пользователю.
effectiveBasePermissionsForUI
enableAttachments	Инициализирует новый экземпляр объекта SP.FieldCalculatedErrorValue.
enableFolderCreation	Получает назначения ролей для защищаемого объекта.
enableMinorVersions	Получает или задает значение, указывающее, включены ли дополнительные версии для списка.
enableModeration	Изменение элемента.
enableVersioning	Получает или задает значение, указывающее, можно ли создавать в списке исторические версии элементов списка и документов.
entityTypeName
eventReceivers
поля	Получает значение, задающее время создания файла.
forceCheckout	Получает или задает значение, указывающее, включено ли для библиотеки документов принудительное извлечение.
формы	Получает или задает значение, указывающее, можно ли использовать конструктор в этом семействе веб-сайтов.
hasExternalDataSource	Удаляет функцию с указанным идентификатором из коллекции.
скрытые	Получает или задает логическое значение, указывающее, индексировано ли поле.
идентификатор.	Получает значение, задающее коллекцию шаблонов рабочих процессов, связанных с сайтом.
imageUrl	Получает значение, задающее универсальный код ресурса (URI) значка списка.
informationRightsManagementSettings
irmEnabled
irmExpire
irmReject
isApplicationList	Получает или задает значение, указывающее флаг, который клиентское приложение может использовать, чтобы определить, следует ли отображать список.
isCatalog	Получает эффективные базовые разрешения для текущего пользователя в виде, в котором они должны отображаться в пользовательском интерфейсе.
isPrivate
isSiteAssetsLibrary	Получает значение, указывающее, предназначен ли список как расположение по умолчанию для изображений и других файлов, которые пользователи отправляют на свои вики-страницы.
itemCount	Получает или задает значение, задающее схему нового списка.
lastItemDeletedDate	Получает или задает значение, указывающее, может ли URL-адрес узла навигации соответствовать страницам вне семейства веб-сайтов.
lastItemModifiedDate	reservemember
listItemEntityTypeFullName
multipleDataList	Инициализирует новый экземпляр объекта SP.ViewCreationInformation.
noCrawl	Получает или задает значение, указывающее, что программа-обходчик не должна обходить список.
onQuickLaunch	Получает или задает значение, указывающее, отображается ли список в панели быстрого запуска на сайте.
parentWeb	Получает коллекцию пар "ключ-значение" с именами и значениями полей.
parentWebUrl	Получает значение, задающее зависящий от сервера URL-адрес сайта со списком.
rootFolder	olpiainternal
schemaXml	для всплывающего меню.
serverTemplateCanCreateFolders	Получает или задает значение, задающее выходной формат поля.
templateFeatureId	Получает значение, указывающее список, который содержит измененное представление.
Название	Получает или задает отображаемый заголовок списка.
userCustomActions	Задает поле с пользователем.
validationFormula	Получает GUID, указывающий семейство веб-сайтов.
validationMessage	Представляет коллекцию объектов SP.FieldLink, которые являются ссылками на столбцы или поля в типе контента.
представления	Получает или задает имя URL-адреса нового сайта.
workflowAssociations	Получает значение, задающее коллекцию всех сопоставлений рабочих процессов в списке.

Замечания

Свойства BrowserFileHandling, источник данных, EffectiveBasePermissions, HasUniqueRoleAssignments, IsAttachmentLibrary, OnQuickLaunch, SchemaXml, ValidationFormula и ValidationMessage не включаются в скалярные свойства по умолчанию для этого типа.

Пример

В следующем примере создается кнопку ввода на страницу приложения, который создает новый список доска обсуждений на текущем веб-сайте.

<asp:Content ID="Main" ContentPlaceHolderID="PlaceHolderMain" runat="server">
<script type="text/ecmascript" language="ecmascript">

    var list;
    function runCode() {
        var clientContext = new SP.ClientContext.get_current();

        if (clientContext != undefined && clientContext != null) {
            var web = clientContext.get_web();

            // Specify the properties of the new list.
            var listCreationInfo = new SP.ListCreationInformation();
            listCreationInfo.set_title('New Discussion Board');
            listCreationInfo.set_templateType(SP.ListTemplateType.discussionBoard);

            this.list = web.get_lists().add(listCreationInfo);

            clientContext.load(list);
            clientContext.executeQueryAsync(Function.createDelegate(this, this.onQuerySucceeded), Function.createDelegate(this, this.onQueryFailed));
        }
    }

    function onQuerySucceeded() {
        var result = ' Added Discussion Board: ' + this.list.get_title();
        alert(result);
    }

    function onQueryFailed(sender, args) {
        alert('Request failed. ' + args.get_message() + '\n' + args.get_stackTrace());
    }

</script>

    <input id="Button1" type="button" value="Run Code" onclick="runCode()" />

</asp:Content>

Конечная точка ресурса REST

Дополнительные сведения см. в разделе Ресурс в виде списка.

Структура URI конечной точки

http://<sitecollection>/<site>/_api/web/lists(listid)

Запросы HTTP

Этот ресурс поддерживает следующие команды HTTP:

Delete.

Синтаксис DELETE

DELETE http://<sitecollection>/<site>/_api/web/lists(listid)

Синтаксис MERGE

MERGE http://<sitecollection>/<site>/_api/web/lists(listid)

Синтаксис POST

POST http://<sitecollection>/<site>/_api/web/lists(listid)

Синтаксис PUT

PUT http://<sitecollection>/<site>/_api/web/lists(listid)

Поделиться через