SP 名前空間 (sp.js)
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.
**適用対象:**apps for SharePoint | SharePoint Foundation 2013 | SharePoint Server 2013
Objects
The following table lists objects in the SP namespace that are supported for public use in Microsoft SharePoint Foundation 2013.
Name |
Description |
---|---|
Specifies a set of built-in permissions. |
|
Specifies a Collaborative Application Markup Language (CAML) query on a list. |
|
Base type for a description of a change to an object. |
|
Indicates a change to an alert. |
|
Represents a collection of SP.Change objects. |
|
Indicates a change to an SP.ContentType object. |
|
A change on a Field. |
|
A change on a File not contained in a document library. |
|
A change on a Folder not contained in a list or document library. |
|
A change on a Group. |
|
A change on an item. |
|
A change on a list. |
|
Defines a query that is performed against the change log. |
|
Represents the unique sequential location of a change within the change log. |
|
A change on a user. |
|
A change on a view. |
|
A change on a site. |
|
Represents the context for SharePoint objects and operations. |
|
Represents a Web site or list content type. |
|
Represents a collection of Web site or list content types. |
|
Specifies properties that are used as parameters to initialize a new content type. |
|
Represents the content type identifier (ID) of a content type. |
|
Represents an activated feature. |
|
Represents a collection of SP.Feature objects. |
|
Represents a field in a list on a Microsoft SharePoint Foundation Web site. |
|
Specifies a calculated field. |
|
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. |
|
Represents a choice field control. |
|
Represents a collection of SP.Field objects. |
|
Specifies a computed field. |
|
Specifies a field that contains currency values. |
|
Specifies a field that contains date and time values. |
|
Specifies a reference to a field or field definition for a content type. |
|
Represents a collection of SP.FieldLink objects that are column or field references in a content type. |
|
Contains properties that are used as parameters to initialize a FieldLink. |
|
Specifies a lookup field. |
|
Specifies the value of a lookup for a field within a list item. |
|
Specifies a field that contains one or more values from a set of specified values. |
|
Specifies a field that can contain multiple lines of text. |
|
Specifies a field that contains number values. |
|
Specifies a field that contains rating scale values for a survey list. |
|
Represents a specific sub question and answer within a rating scale field of a list item. |
|
Represents a collection of key/value pairs that specify string values for fields. |
|
Specifies a field that contains a single line of text. |
|
Specifies a field that contains a URL. |
|
Specifies the hyperlink and the description values for FieldURL. |
|
Specifies a field that contains a user. |
|
Represents the value of a user field for a list item. |
|
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. |
|
Represents a collection of SP.File objects. |
|
Represents a version of a SP.File object. |
|
Represents a collection of SP.FileVersion objects. |
|
Represents a folder on a SharePoint Web site. |
|
Represents a collection of SP.Folder objects. |
|
A form provides a display and editing interface for a single list item. |
|
Represents a collection of SP.Form objects for a list. |
|
Represents a group on a Microsoft SharePoint Foundation Web site. |
|
Represents a collection of SP.Group objects. |
|
An object used to facilitate creation of a cross-site group. |
|
Represents a list on a SharePoint Web site. |
|
Represents a collection of SP.List objects. |
|
Specifies the properties of the new list. |
|
Represents information associated with a connection to an external data source. |
|
The exception that is thrown when the data for a list field or list item fails validation. |
|
Describes a specific validation failure when a list item is inserted or updated. |
|
Represents an item or row in a list. |
|
Represents a collection of SP.ListItem objects. |
|
Specifies the information required to get the next page of data for a list view. |
|
Specifies the properties of the new list item. |
|
Specifies a list template. |
|
Represents a collection of SP.ListTemplate objects. |
|
Represents navigation operations at the site collection level. |
|
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. |
|
Represents a collection of SP.NavigationNode objects. |
|
Describes a new navigation node to be created. |
|
Represents a user or group that can be assigned permissions to control security. |
|
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. |
|
Represents a Recycle Bin item in the Recycle Bin of a site or a site collection. |
|
Represents a collection of SP.RecycleBinItem objects. |
|
Specifies a relationship to a lookup field. |
|
Represents a collection of SP.RelatedField objects storing properties of relationship lookup fields. |
|
This object and its members are reserved for internal use and are not intended to be used in your code. |
|
This object and its members are reserved for internal use and are not intended to be used in your code. |
|
This object and its members are reserved for internal use and are not intended to be used in your code. |
|
Defines the securable object role assignments for a user or group on the Web site, list, or list item. |
|
Represents a collection of SP.RoleAssignment objects that defines all the role assignments for each securable object. |
|
Defines a single role definition, including a name, description, and set of rights. |
|
Defines the role definitions that are bound to a role assignment object. |
|
Represents the collection of SP.RoleDefinition objects that define the role definitions that are available for use within the Web site. |
|
Contains properties that are used as parameters to initialize a role definition. |
|
An object that can be assigned security permissions. |
|
Represents a collection of sites in a Web application, including a top-level Web site and all its subsites. |
|
Defines a query that is used with the SP へWeb.getSubwebsForCurrentUser 方法 (sp.js) to specify which child Web sites to return from a Web site. |
|
Provides fields that are used to access information about site collection usage. |
|
Represents a user in Microsoft SharePoint Foundation. |
|
Represents a collection of SP.User object. |
|
Parameters to invite a user. |
|
Represents a custom action associated with a SharePoint list, Web site, or subsite. |
|
Represents a collection of SP.UserCustomAction objects. |
|
Specifies a list view. |
|
Represents a collection of SP.View object |
|
Specifies the properties used to create a new list view. |
|
Represents a collection of fields in a list view. |
|
Represents a Microsoft SharePoint Foundation Web site. |
|
Represents a collection of SP.Web objects. |
|
Specifies the properties of a new site. |
|
Specifies a site definition or a site template that is used to instantiate a site. |
|
Specifies a collection of site templates. |
|
Represents an SP へアプリのオブジェクト (sp.js) object installed to a specific Web site. |
|
Represents an app license for the specified user for the specified SharePoint アドイン . |
|
Represents the creation information for a list item attachment. |
|
Specifies a set of built-in permissions. |
|
Represents a query in a list view. |
|
Base class for a change. installation. |
|
A change from an SPAlert. |
|
Represents a collection of Microsoft.SharePoint.SPChange objects. |
|
A change on an SPContentType. |
|
A change on an SPField. |
|
A change on an SPFile. |
|
A change on an SPFolder. |
|
A change on an SPGroup. |
|
A change on a SharePoint item. installation. |
|
A change on an SPList. |
|
Represents the input parameter of the GetListItemChangesSinceToken method. |
|
Defines a query that is performed against the change log in <token>wssnoverslong</token>. |
|
Represents the unique sequential location of a change within the change log. |
|
A change on an SPUser. |
|
A change on an SPView. |
|
A change on an SPWeb. |
|
Represents the context for objects and operations. |
|
SPContentType |
|
Represents a collection of site or list content types. |
|
Specifies properties that are used as parameters to initialize a new content type. |
|
Represents the content type identifier (ID) of a content type. |
|
Abstract base class that defines general properties of an event receiver. |
|
Represents a collection of EventReceiverDefinition objects that are used to enumerate a list of registered event receivers for Microsoft SharePoint Foundation objects. |
|
Specifies event receiver creation information. |
|
The top level object representing a SharePoint Feature activation. |
|
Represents a collection of SPFeature objects. |
|
Represents a field in a list on a Microsoft SharePoint Foundation Web site. |
|
Specifies a calculated field. |
|
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. |
|
Represents a choice field control. |
|
Represents a collection of SP.Field objects. |
|
Represents a computed field, which is a field that depends on another field for its contents. |
|
Specifies a field that contains currency values. |
|
Specifies a field that contains date and time values. |
|
SPFieldGeolocationValue: field value class for GeolocationField (geographical type for Point) |
|
SPFieldLink |
|
SPFieldLinkCollection |
|
Contains properties that are used as parameters to initialize a FieldLink. |
|
Specifies a lookup field. |
|
SPFieldLookupValue: field value class for SPFieldLookup (Lookup field) |
|
Specifies a field that contains one or more values from a set of specified values. |
|
Specifies a field that can contain multiple lines of text. |
|
Specifies a field that contains number values. |
|
Specifies a field that contains rating scale values for a survey list. |
|
Represents a specific sub question and answer within a rating scale field of a list item. |
|
Represents a collection of key/value pairs that specify string values for fields. |
|
Specifies a field that contains a single line of text. |
|
Specifies a field that contains a URL. |
|
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 ','. |
|
Specifies a field that contains a user. |
|
SPFieldUserValue: field value class for SPFieldUser (User field) |
|
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. |
|
Represents a collection of SP.File objects. |
|
Represents properties that can be set when creating a file by using the FileCollection.Add method. |
|
Represents a version of a SP.File object. |
|
Represents a collection of SP.FileVersion objects. |
|
Represents a folder on a SharePoint Web site. |
|
Represents a collection of SP.Folder objects. |
|
A form provides a display and editing interface for a single list item. |
|
Represents a collection of SP.Form objects for a list. |
|
Summary description for SPGroup. |
|
Represents a collection of SP.Group objects. |
|
An object used to facilitate creation of a cross-site group. |
|
A collection of Information Rights Management settings of list. |
|
Represents a natural language used within the context of Microsoft Windows SharePoint Services. |
|
Represents a list on a SharePoint Web site. |
|
Represents a collection of SP.List objects. |
|
Specifies the properties of the new list. |
|
Represents information associated with a connection to an external data source. |
|
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. |
|
This class describes a specific validation failure during a list item insert or update. |
|
Represents an item or row in a list. |
|
Represents a collection of SPListItem objects. |
|
Specifies the information required to get the next page of data for a list view. |
|
Specifies the properties of the new list item. |
|
Represents properties of a list item field and its value. |
|
Specifies a list template. |
|
Represents a collection of SP.ListTemplate objects. |
|
Represents navigation operations at the site collection level. |
|
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. |
|
Represents a collection of SP.NavigationNode objects. |
|
Describes a new navigation node to be created. |
|
Contains information about the sharing state of a securable object. |
|
Contains information about a user with whom a securable object is shared. |
|
Represents a user or group that can be assigned permissions in Windows SharePoint Services to control security. |
|
Contains CSOM expando properties, which are a collection of name/value pairs. |
|
Represents a push notification subscriber over a site. |
|
Represents a collection of push notification subscribers over a site. |
|
Represents an item in the Recycle Bin for a Web site or a site collection. |
|
Represents a collection of SPRecycleBinItem objects. |
|
Represents regional settings that are used on the server that is running Microsoft SharePoint Foundation. |
|
Specifies a relationship to a lookup field. |
|
Represents a collection of SP.RelatedField objects storing properties of relationship lookup fields. |
|
このクラスとそのメンバーは内部使用のために予約済みです。ユーザーのコード内で使用されるものではありません。 |
|
このクラスとそのメンバーは内部使用のために予約済みです。ユーザーのコード内で使用されるものではありません。 |
|
SPContext: provide basic WSS context information: site, web, list, listitem |
|
Defines the securable object role assignments for a user or group on the Web site, list, or list item. |
|
Represents a collection of SP.RoleAssignment objects that defines all the role assignments for each securable object. |
|
Defines a single role definition, including a name, description, and set of rights. |
|
Defines the role definitions that are bound to a role assignment object. |
|
Represents the collection of SP.RoleDefinition objects that define the role definitions that are available for use within the Web site. |
|
Contains properties that are used as parameters to initialize a role definition. |
|
for backwards compatibility, we should keep ISecurableObject untouched, and add new methods here. |
|
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. |
|
Represents information about a time zone. |
|
a trimmed down version of SPSiteUpgradeSessionInfo, to be presented to site admin (SiteId, SessionId, SessionXML is removed) |
|
Provides fields that are used to access information about site collection usage. |
|
Represents a user in Microsoft SharePoint Foundation. |
|
Represents a collection of SP へユーザー オブジェクト (sp.js). |
|
Parameters to invite a user. |
|
SPUserCustomAction public OM |
|
Represents a collection of SP.UserCustomAction objects. |
|
The identity information of a user, which contains user's name and the issuer of the user's name. |
|
Specifies the properties used to create a new list view. |
|
Represents a collection of fields in a list view. |
|
SPWeb class. The top level object representing a SharePoint Web. |
|
Represents a collection of SP へWeb オブジェクト (sp.js). |
|
Specifies the properties of a new site. |
|
Represents the data from the caller needed to make the outbound web request. |
|
Contains a copy of the third-party service response. |
|
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. |
|
The collection of web templates. To make it be accessable from ListControl.DataSource, we need to implement ICollection interface. |
Enumerations
The following table lists enumerations in the SP namespace that are supported for public use in Microsoft SharePoint Foundation 2013.
Name |
Description |
---|---|
Specifies the control settings while adding a field. |
|
Specifies the base type for a list. |
|
Specifies whether the file is allowed to be displayed in the Web browser. |
|
A calendar type is a 2-byte integer value that specifies the type of calendar to use in a particular context. |
|
Enumeration of the possible types of changes. |
|
Specifies the type of check-in for a file. |
|
Describes the different checkout states of a file, independent of the lock state of the file. |
|
Specifies how options for how to display selections in a choice field. |
|
Specifies the cache and customization status for a page. |
|
Specifies the display format for date and time fields. |
|
Specifies the minimum permission required to view minor versions and drafts. |
|
Specifies the feature scope for a feature definition. |
|
Specifies the type of the field. |
|
Specifies whether users and groups or only users can be selected. |
|
Specifies the publishing level for a file. |
|
Specifies the file system object type. |
|
Describes the reason why a list item or a list item field failed validation. |
|
Describes the type of validation that caused a failure. |
|
Specifies list server templates. |
|
Specifies criteria for how to move files. |
|
Page Type is a signed 1-byte integer that is used to represent the possible page types. |
|
Specifies whether the list is displayed on the Quick Launch of the site. |
|
Specifies the Recycle Bin stage of the Recycle Bin item. |
|
Specifies the type of the Recycle Bin item. |
|
Specifies the optional relationship behavior of a relationship lookup field. |
|
Specifies the types of roles that are available for users and groups. |
|
Specifies the type of template used for ghosted file creation. |
|
Indicates the amount of detail in a trace message. |
|
Specifies the display format of the field. |
|
Specifies the type of object associated with the custom action. |
|
Specifies the scope of the custom action. |
|
Specifies the scope for returning list items and list folders in a list view. |
|
Specifies the type of the list view. |