Export (0) Print
Expand All
Expand Minimize

SP namespace (sp.js)

SharePoint 2013

Provides a subset of types and members in the Microsoft.SharePoint namespace for working with a top-level site and its lists or child Web sites.

The following table lists objects in the SP namespace that are supported for public use in Microsoft SharePoint Foundation 2013.

Name

Description

AlternateUrl

App

AppInstance

AppLicense

AppLicenseCollection

Attachment

AttachmentCollection

AttachmentCreationInformation

BasePermissions

Specifies a set of built-in permissions.

CamlQuery

Specifies a Collaborative Application Markup Language (CAML) query on a list.

Change

Base type for a description of a change to an object.

ChangeAlert

Indicates a change to an alert.

ChangeCollection

Represents a collection of SP.Change objects.

ChangeContentType

Indicates a change to an SP.ContentType object.

ChangeField

A change on a Field.

ChangeFile

A change on a File not contained in a document library.

ChangeFolder

A change on a Folder not contained in a list or document library.

ChangeGroup

A change on a Group.

ChangeItem

A change on an item.

ChangeList

A change on a list.

ChangeLogItemQuery

ChangeQuery

Defines a query that is performed against the change log.

ChangeToken

Represents the unique sequential location of a change within the change log.

ChangeUser

A change on a user.

ChangeView

A change on a view.

ChangeWeb

A change on a site.

ClientContext

Represents the context for SharePoint objects and operations.

ContentType

Represents a Web site or list content type.

ContentTypeCollection

Represents a collection of Web site or list content types.

ContentTypeCreationInformation

Specifies properties that are used as parameters to initialize a new content type.

ContentTypeId

Represents the content type identifier (ID) of a content type.

EventReceiverDefinition

EventReceiverDefinitionCollection

EventReceiverDefinitionCreationInformation

Feature

Represents an activated feature.

FeatureCollection

Represents a collection of SP.Feature objects.

Field

Represents a field in a list on a Microsoft SharePoint Foundation Web site.

FieldCalculated

Specifies a calculated field.

FieldCalculatedErrorValue

Represents the value of the calculated field of a list item when the value of the field is a calculation error, such as division by zero or overflow.

FieldChoice

Represents a choice field control.

FieldCollection

Represents a collection of SP.Field objects.

FieldComputed

Specifies a computed field.

FieldCurrency

Specifies a field that contains currency values.

FieldDateTime

Specifies a field that contains date and time values.

FieldGeolocationValue

FieldLink

Specifies a reference to a field or field definition for a content type.

FieldLinkCollection

Represents a collection of SP.FieldLink objects that are column or field references in a content type.

FieldLinkCreationInformation

Contains properties that are used as parameters to initialize a FieldLink.

FieldLookup

Specifies a lookup field.

FieldLookupValue

Specifies the value of a lookup for a field within a list item.

FieldMultiChoice

Specifies a field that contains one or more values from a set of specified values.

FieldMultiLineText

Specifies a field that can contain multiple lines of text.

FieldNumber

Specifies a field that contains number values.

FieldRatingScale

Specifies a field that contains rating scale values for a survey list.

FieldRatingScaleQuestionAnswer

Represents a specific sub question and answer within a rating scale field of a list item.

FieldStringValues

Represents a collection of key/value pairs that specify string values for fields.

FieldText

Specifies a field that contains a single line of text.

FieldUrl

Specifies a field that contains a URL.

FieldUrlValue

Specifies the hyperlink and the description values for FieldURL.

FieldUser

Specifies a field that contains a user.

FieldUserValue

Represents the value of a user field for a list item.

File

Represents a file in a SharePoint Web site that can be a Web Part Page, an item in a document library, or a file in a folder.

FileCollection

Represents a collection of SP.File objects.

FileVersion

Represents a version of a SP.File object.

FileVersionCollection

Represents a collection of SP.FileVersion objects.

Folder

Represents a folder on a SharePoint Web site.

FolderCollection

Represents a collection of SP.Folder objects.

Form

A form provides a display and editing interface for a single list item.

FormCollection

Represents a collection of SP.Form objects for a list.

Group

Represents a group on a Microsoft SharePoint Foundation Web site.

GroupCollection

Represents a collection of SP.Group objects.

GroupCreationInformation

An object used to facilitate creation of a cross-site group.

InformationRightsManagementSettings

List

Represents a list on a SharePoint Web site.

ListCollection

Represents a collection of SP.List objects.

ListCreationInformation

Specifies the properties of the new list.

ListDataSource

Represents information associated with a connection to an external data source.

ListDataValidationExceptionValue

The exception that is thrown when the data for a list field or list item fails validation.

ListDataValidationFailure

Describes a specific validation failure when a list item is inserted or updated.

ListItem

Represents an item or row in a list.

ListItemCollection

Represents a collection of SP.ListItem objects.

ListItemCollectionPosition

Specifies the information required to get the next page of data for a list view.

ListItemCreationInformation

Specifies the properties of the new list item.

ListItemEntityCollection

ListItemFormUpdateValue

ListTemplate

Specifies a list template.

ListTemplateCollection

Represents a collection of SP.ListTemplate objects.

Navigation

Represents navigation operations at the site collection level.

NavigationNode

Represents the URL to a specific navigation node and provides access to properties and methods for manipulating the ordering of the navigation node in a navigation node collection.

NavigationNodeCollection

Represents a collection of SP.NavigationNode objects.

NavigationNodeCreationInformation

Describes a new navigation node to be created.

ObjectSharingInformation

ObjectSharingInformationUser

Principal

Represents a user or group that can be assigned permissions to control security.

PropertyValues

Contains CSOM expando properties, which are a collection of name/value pairs. The CSOM expando field name is the name part in the name/value pair. The CSOM expando property value is the value part in the name/value pair.

PushNotificationSubscriber

PushNotificationSubscriberCollection

RecycleBinItem

Represents a Recycle Bin item in the Recycle Bin of a site or a site collection.

RecycleBinItemCollection

Represents a collection of SP.RecycleBinItem objects.

RegionalSettings

RelatedField

Specifies a relationship to a lookup field.

RelatedFieldCollection

Represents a collection of SP.RelatedField objects storing properties of relationship lookup fields.

RelatedFieldExtendedData

This object and its members are reserved for internal use and are not intended to be used in your code.

RelatedFieldExtendedDataCollection

This object and its members are reserved for internal use and are not intended to be used in your code.

RelatedItem

RequestContext

This object and its members are reserved for internal use and are not intended to be used in your code.

RequestVariable

RoleAssignment

Defines the securable object role assignments for a user or group on the Web site, list, or list item.

RoleAssignmentCollection

Represents a collection of SP.RoleAssignment objects that defines all the role assignments for each securable object.

RoleDefinition

Defines a single role definition, including a name, description, and set of rights.

RoleDefinitionBindingCollection

Defines the role definitions that are bound to a role assignment object.

RoleDefinitionCollection

Represents the collection of SP.RoleDefinition objects that define the role definitions that are available for use within the Web site.

RoleDefinitionCreationInformation

Contains properties that are used as parameters to initialize a role definition.

SecurableObject

An object that can be assigned security permissions.

Site

Represents a collection of sites in a Web application, including a top-level Web site and all its subsites.

SubwebQuery

Defines a query that is used with the SP.Web.getSubwebsForCurrentUser Method (sp.js) to specify which child Web sites to return from a Web site.

ThemeInfo

TimeZone

TimeZoneCollection

TimeZoneInformation

UsageInfo

Provides fields that are used to access information about site collection usage.

User

Represents a user in Microsoft SharePoint Foundation.

UserCollection

Represents a collection of SP.User object.

UserCreationInformation

Parameters to invite a user.

UserCustomAction

Represents a custom action associated with a SharePoint list, Web site, or subsite.

UserCustomActionCollection

Represents a collection of SP.UserCustomAction objects.

UserIdInfo

View

Specifies a list view.

ViewCollection

Represents a collection of SP.View object

ViewCreationInformation

Specifies the properties used to create a new list view.

ViewFieldCollection

Represents a collection of fields in a list view.

Web

Represents a Microsoft SharePoint Foundation Web site.

WebCollection

Represents a collection of SP.Web objects.

WebCreationInformation

Specifies the properties of a new site.

WebInformation

WebRequestInfo

WebResponseInfo

WebTemplate

Specifies a site definition or a site template that is used to instantiate a site.

WebTemplateCollection

Specifies a collection of site templates.

AccessRequests

AlternateUrl

AppCatalog

AppContextSite

AppInstance

Represents an SP.App object (sp.js) object installed to a specific Web site.

AppInstanceErrorDetails

AppLicense

AppLicenseCollection

AttachmentCreationInformation

Represents the creation information for a list item attachment.

BasePermissions

Specifies a set of built-in permissions.

CamlQuery

Represents a query in a list view.

Change

Base class for a change. installation.

ChangeAlert

A change from an SPAlert.

ChangeCollection

Represents a collection of Microsoft.SharePoint.SPChange objects.

ChangeContentType

A change on an SPContentType.

ChangeField

A change on an SPField.

ChangeFile

A change on an SPFile.

ChangeFolder

A change on an SPFolder.

ChangeGroup

A change on an SPGroup.

ChangeItem

A change on a SharePoint item. installation.

ChangeList

A change on an SPList.

ChangeLogItemQuery

ChangeQuery

Defines a query that is performed against the change log in <token>wssnoverslong</token>.

ChangeToken

Represents the unique sequential location of a change within the change log.

ChangeUser

A change on an SPUser.

ChangeView

A change on an SPView.

ChangeWeb

A change on an SPWeb.

ClientContext

Represents the context for objects and operations.

ContentType

SPContentType

ContentTypeCollection

Represents a collection of site or list content types.

ContentTypeCreationInformation

Specifies properties that are used as parameters to initialize a new content type.

ContentTypeId

Represents the content type identifier (ID) of a content type.

EventReceiverDefinition

Abstract base class that defines general properties of an event receiver.

EventReceiverDefinitionCollection

Represents a collection of EventReceiverDefinition objects that are used to enumerate a list of registered event receivers for Microsoft SharePoint Foundation objects.

EventReceiverDefinitionCreationInformation

Specifies event receiver creation information.

Feature

The top level object representing a SharePoint Feature activation.

FeatureCollection

Represents a collection of SPFeature objects.

Field

Represents a field in a list on a Microsoft SharePoint Foundation Web site.

FieldCalculated

Specifies a calculated field.

FieldCalculatedErrorValue

Represents the value of the calculated field of a list item when the value of the field is a calculation error, such as division by zero or overflow.

FieldChoice

Represents a choice field control.

FieldCollection

Represents a collection of SP.Field objects.

FieldComputed

Represents a computed field, which is a field that depends on another field for its contents.

FieldCurrency

Specifies a field that contains currency values.

FieldDateTime

Specifies a field that contains date and time values.

FieldGeolocationValue

SPFieldGeolocationValue: field value class for GeolocationField (geographical type for Point)

FieldLink

SPFieldLink

FieldLinkCollection

SPFieldLinkCollection

FieldLinkCreationInformation

Contains properties that are used as parameters to initialize a FieldLink.

FieldLookup

Specifies a lookup field.

FieldLookupValue

SPFieldLookupValue: field value class for SPFieldLookup (Lookup field)

FieldMultiChoice

Specifies a field that contains one or more values from a set of specified values.

FieldMultiLineText

Specifies a field that can contain multiple lines of text.

FieldNumber

Specifies a field that contains number values.

FieldRatingScale

Specifies a field that contains rating scale values for a survey list.

FieldRatingScaleQuestionAnswer

Represents a specific sub question and answer within a rating scale field of a list item.

FieldStringValues

Represents a collection of key/value pairs that specify string values for fields.

FieldText

Specifies a field that contains a single line of text.

FieldUrl

Specifies a field that contains a URL.

FieldUrlValue

SPFieldUrlValue: field value class for SPFieldUrl (URL type field) Assumption: delimiter is ", ", i.e. comma followed by a space. If URL value contains ',', is is escaped as ',,'. URL description do not escape ','.

FieldUser

Specifies a field that contains a user.

FieldUserValue

SPFieldUserValue: field value class for SPFieldUser (User field)

File

Represents a file in a SharePoint Web site that can be a Web Part Page, an item in a document library, or a file in a folder.

FileCollection

Represents a collection of SP.File objects.

FileCreationInformation

FileSaveBinaryInformation

FileVersion

Represents a version of a SP.File object.

FileVersionCollection

Represents a collection of SP.FileVersion objects.

Folder

Represents a folder on a SharePoint Web site.

FolderCollection

Represents a collection of SP.Folder objects.

Form

A form provides a display and editing interface for a single list item.

FormCollection

Represents a collection of SP.Form objects for a list.

Group

Summary description for SPGroup.

GroupCollection

Represents a collection of SP.Group objects.

GroupCreationInformation

An object used to facilitate creation of a cross-site group.

InformationRightsManagementSettings

A collection of Information Rights Management settings of list.

Language

Represents a natural language used within the context of Microsoft Windows SharePoint Services.

List

Represents a list on a SharePoint Web site.

ListCollection

Represents a collection of SP.List objects.

ListCreationInformation

Specifies the properties of the new list.

ListDataSource

Represents information associated with a connection to an external data source.

ListDataValidationExceptionValue

This exception should be thrown if and only if an error occurs during list data field or item validation. For a more complete description of what is meant by "field or item validation" in this context, see the file header in sts\tp\tsapi\listdatavalidation.h.

ListDataValidationFailure

This class describes a specific validation failure during a list item insert or update.

ListItem

Represents an item or row in a list.

ListItemCollection

Represents a collection of SPListItem objects.

ListItemCollectionPosition

Specifies the information required to get the next page of data for a list view.

ListItemCreationInformation

Specifies the properties of the new list item.

ListItemEntityCollection

ListItemFormUpdateValue

ListTemplate

Specifies a list template.

ListTemplateCollection

Represents a collection of SP.ListTemplate objects.

Navigation

Represents navigation operations at the site collection level.

NavigationNode

Represents the URL to a specific navigation node and provides access to properties and methods for manipulating the ordering of the navigation node in a navigation node collection.

NavigationNodeCollection

Represents a collection of SP.NavigationNode objects.

NavigationNodeCreationInformation

Describes a new navigation node to be created.

ObjectSharingInformation

Contains information about the sharing state of a securable object.

ObjectSharingInformationUser

Contains information about a user with whom a securable object is shared.

Principal

Represents a user or group that can be assigned permissions in Windows SharePoint Services to control security.

PropertyValues

Contains CSOM expando properties, which are a collection of name/value pairs.

PushNotificationSubscriber

Represents a push notification subscriber over a site.

PushNotificationSubscriberCollection

Represents a collection of push notification subscribers over a site.

RecycleBinItem

Represents an item in the Recycle Bin for a Web site or a site collection.

RecycleBinItemCollection

Represents a collection of SPRecycleBinItem objects.

RegionalSettings

Represents regional settings that are used on the server that is running Microsoft SharePoint Foundation.

RelatedField

Specifies a relationship to a lookup field.

RelatedFieldCollection

Represents a collection of SP.RelatedField objects storing properties of relationship lookup fields.

RelatedFieldExtendedData

This class and its members are reserved for internal use and are not intended to be used in your code.

RelatedFieldExtendedDataCollection

This class and its members are reserved for internal use and are not intended to be used in your code.

RelatedItem

RelatedItemManager

RequestContext

SPContext: provide basic WSS context information: site, web, list, listitem

RequestVariable

RoleAssignment

Defines the securable object role assignments for a user or group on the Web site, list, or list item.

RoleAssignmentCollection

Represents a collection of SP.RoleAssignment objects that defines all the role assignments for each securable object.

RoleDefinition

Defines a single role definition, including a name, description, and set of rights.

RoleDefinitionBindingCollection

Defines the role definitions that are bound to a role assignment object.

RoleDefinitionCollection

Represents the collection of SP.RoleDefinition objects that define the role definitions that are available for use within the Web site.

RoleDefinitionCreationInformation

Contains properties that are used as parameters to initialize a role definition.

SecurableObject

for backwards compatibility, we should keep ISecurableObject untouched, and add new methods here.

ServerSettings

SubwebQuery

Defines a query that is used with the SP.Web.getSubwebsForCurrentUser Method (sp.js) to specify which child Web sites to return from a Web site.

ThemeInfo

TimeZone

TimeZoneCollection

TimeZoneInformation

ULS

UpgradeInfo

a trimmed down version of SPSiteUpgradeSessionInfo, to be presented to site admin (SiteId, SessionId, SessionXML is removed)

UsageInfo

Provides fields that are used to access information about site collection usage.

User

Represents a user in Microsoft SharePoint Foundation.

UserCollection

Represents a collection of SP.User object (sp.js).

UserCreationInformation

Parameters to invite a user.

UserCustomAction

SPUserCustomAction public OM

UserCustomActionCollection

Represents a collection of SP.UserCustomAction objects.

UserIdInfo

The identity information of a user, which contains user's name and the issuer of the user's name.

ViewCreationInformation

Specifies the properties used to create a new list view.

ViewFieldCollection

Represents a collection of fields in a list view.

Web

SPWeb class. The top level object representing a SharePoint Web.

SPWeb class. The top level object representing a SharePoint Web.

SPWeb class. The top level object representing a SharePoint Web.

WebCollection

Represents a collection of SP.Web object (sp.js).

WebCreationInformation

Specifies the properties of a new site.

WebInformation

WebProxy

WebRequestInfo

WebResponseInfo

Contains a copy of the third-party service response.

WebTemplate

Represents a site definition or a site template that is used to instantiate a SharePoint site. Site definitions are contained in files within <codeInline>\\Program Files\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE</codeInline>, while site templates are created through the user interface or through the object model when a site is saved as a template.

WebTemplateCollection

The collection of web templates. To make it be accessable from ListControl.DataSource, we need to implement ICollection interface.

The following table lists enumerations in the SP namespace that are supported for public use in Microsoft SharePoint Foundation 2013.

Name

Description

AddFieldOptions

Specifies the control settings while adding a field.

AppInstanceStatus

AppLicenseType

BaseType

Specifies the base type for a list.

BrowserFileHandling

Specifies whether the file is allowed to be displayed in the Web browser.

CalendarType

A calendar type is a 2-byte integer value that specifies the type of calendar to use in a particular context.

ChangeType

Enumeration of the possible types of changes.

CheckinType

Specifies the type of check-in for a file.

CheckOutType

Describes the different checkout states of a file, independent of the lock state of the file.

ChoiceFormatType

Specifies how options for how to display selections in a choice field.

CustomizedPageStatus

Specifies the cache and customization status for a page.

DateTimeFieldFormatType

Specifies the display format for date and time fields.

DateTimeFieldFriendlyFormatType

DraftVisibilityType

Specifies the minimum permission required to view minor versions and drafts.

EventReceiverSynchronization

EventReceiverType

FeatureDefinitionScope

Specifies the feature scope for a feature definition.

FieldType

Specifies the type of the field.

FieldUserSelectionMode

Specifies whether users and groups or only users can be selected.

FileLevel

Specifies the publishing level for a file.

FileSystemObjectType

Specifies the file system object type.

ListDataValidationFailureReason

Describes the reason why a list item or a list item field failed validation.

ListDataValidationType

Describes the type of validation that caused a failure.

ListTemplateType

Specifies list server templates.

MoveOperations

Specifies criteria for how to move files.

PageType

Page Type is a signed 1-byte integer that is used to represent the possible page types.

QuickLaunchOptions

Specifies whether the list is displayed on the Quick Launch of the site.

RecycleBinItemState

Specifies the Recycle Bin stage of the Recycle Bin item.

RecycleBinItemType

Specifies the type of the Recycle Bin item.

RelationshipDeleteBehaviorType

Specifies the optional relationship behavior of a relationship lookup field.

RoleType

Specifies the types of roles that are available for users and groups.

TemplateFileType

Specifies the type of template used for ghosted file creation.

ULSTraceLevel

Indicates the amount of detail in a trace message.

UpgradeType

UrlFieldFormatType

Specifies the display format of the field.

UserCustomActionRegistrationType

Specifies the type of object associated with the custom action.

UserCustomActionScope

Specifies the scope of the custom action.

ViewScope

Specifies the scope for returning list items and list folders in a list view.

ViewType

Specifies the type of the list view.

Community Additions

ADD
Show:
© 2014 Microsoft