Share via


SP Namespace

Applies to: SharePoint Foundation 2010

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.

Classes

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

Name

Description

ArrayListEnumerator

Enumerates the values for an array.

Base64EncodedByteArray

Represents a base64-encoded array.

BaseCollection

Represents a collection of objects.

BaseCollectionEnumerator

Enumerates the values for an SP.BaseCollection.

BasePermissions

Specifies a set of built-in permissions.

BWsaClient

Defines a client for adding datapoints and streams to the Software Quality Metrics (SQM) data file.

BWsaConfig

Contains the configuration information for the Software Quality Metrics (SQM) data.

BWsaData

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

BWsaDatapoint

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

BWsaHeader

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

BWsaStream

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

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.

ChangeAlertPropertyNames

Specifies properties of the SP.ChangeAlert Class.

ChangeCollection

Represents a collection of SP.Change Class objects.

ChangeContentType

Indicates a change to SP.ContentType Class.

ChangeContentTypePropertyNames

Specifies properties of the SP.ChangeContentType Class.

ChangeField

A change on a Field.

ChangeFieldPropertyNames

Specifies properties of the SP.ChangeField Class.

ChangeFile

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

ChangeFilePropertyNames

Specifies properties of the SP.ChangeField Class.

ChangeFolder

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

ChangeFolderPropertyNames

Specifies properties of the SP.ChangeFolder Class.

ChangeGroup

A change on a Group.

ChangeGroupPropertyNames

Specifies properties of the SP.ChangeGroup Class.

ChangeItem

A change on an item.

ChangeItemPropertyNames

Specifies properties of the SP.ChangeItem Class.

ChangeList

A change on a list.

ChangeListPropertyNames

Specifies properties of the SP.ChangeList Class.

ChangePropertyNames

Specifies properties of the SP.Change Class.

ChangeQuery

Defines a query that is performed against the change log.

ChangeSite

Specifies a change on a site collection.

ChangeToken

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

ChangeUser

A change on a user.

ChangeUserPropertyNames

Specifies properties of the SP.ChangeUser Class.

ChangeView

A change on a view.

ChangeViewPropertyNames

Specifies properties of the SP.ChangeView Class.

ChangeWeb

A change on a site.

ChangeWebPropertyNames

Specifies properties of the SP.ChangeWeb Class.

ClientAction

Provides an abstract class for invoking methods and setting properties on a server.

ClientActionExecutionScopeEnd

Represents the ending of a client request.

ClientActionExecutionScopeStart

Represents the beginning of a client request.

ClientActionInstantiateObjectPath

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

ClientActionInstantiateObjectPathResult

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

ClientActionInvokeMethod

Records when a client method is invoked. This class and its members are reserved for internal use and are not intended to be used in your code.

ClientActionInvokeStaticMethod

Records the invocation of a client object static method. This class and its members are reserved for internal use and are not intended to be used in your code.

ClientActionSetProperty

Records the setting of the client object static property.

ClientActionSetStaticProperty

Records the setting of a client object static property.

ClientConstants

Contains all the constants related to the SP.ClientObject Class object. This class and its members are reserved for internal use and are not intended to be used in your code.

ClientContext

Represents the context for SharePoint objects and operations.

ClientDictionaryResultHandler

Initializes a generic dictionary with JavaScript Object Notation (JSON) data from the server.

ClientErrorCodes

Contains integer flags that represent the client error codes.

ClientObject

Provides a base class for objects on a remote client.

ClientObjectCollection

Provides a base class for a collection of objects on a remote client.

ClientObjectCollectionPrototype

Provides a base class to specify the "[" to retrieve for a SP.ClientObjectCollectionPrototype Class. This class and its members are reserved for internal use and are not intended to be used in your code.

ClientObjectCollectionResult

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

ClientObjectData

Represents the properties of the client object. This class and its members are reserved for internal use and are not intended to be used in your code.

ClientObjectPrototype

Represents a prototype instance that is used to specify the data to retrieve on the SP.ClientObject Class object. This class and its members are reserved for internal use and are not intended to be used in your code.

ClientQueryInternal

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

ClientQueryProperty

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

ClientRequest

Builds and executes a request from the client to the server.

ClientRequestEventArgs

Provides the SP.ClientRequest Class arguments for the event that is raised when a client request is executed.

ClientRequestFailedEventArgs

Provides data for the exception handling method when a SP.ClientRequest Class execution fails.

ClientRequestSucceededEventArgs

Provides data for the handling method when a SP.ClientRequest Class execution succeeds.

ClientRuntimeContext

Represents the runtime context for accessing data from and invoking methods on remote objects.

ClientSchemaVersions

Represents the version number for the client schema.

ClientValueObject

Represents a local client object model version of a server-side property value.

ContentType

Indicates a change to an SP.ContentType Class object. 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.

ContentTypeObjectPropertyNames

Specifies properties of the SP.ContentType Class.

ContentTypePropertyNames

Specifies properties of the SP.ContentType Class class.

DataConvert

Provides utility methods to convert and output data.

DataRetrievalWithExpressionString

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

EnumerableArray

Represents an enumerable array.

ExceptionHandlingExecutionScope

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

ExceptionHandlingScope

Ignores an exception that is raised by the server, or executes code in response to an exception that is thrown by the server.

ExecutionScope

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

Feature

Represents an activated feature.

FeatureCollection

Represents a collection of SP.Feature Class objects.

FeaturePropertyNames

Specifies properties of the SP.Feature Class.

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.

FieldCalculatedPropertyNames

Specifies properties of the SP.FieldCalculated Class.

FieldChoice

Represents a choice field control.

FieldChoicePropertyNames

Specifies properties of the SP.FieldChoice Class.

FieldCollection

Represents a collection of SP.Field Class objects.

FieldCollectionPropertyNames

Specifies properties of the SP.FieldCollection Class.

FieldComputed

Specifies a computed field.

FieldComputedPropertyNames

Specifies properties of the SP.FieldComputed Class class.

FieldCurrency

Specifies a field that contains currency values.

FieldCurrencyPropertyNames

Specifies properties of the SP.FieldCurrency Class.

FieldDateTime

Specifies a field that contains date and time values.

FieldDateTimePropertyNames

Specifies properties of the SP.FieldDateTime Class.

FieldGuid

Specifies a field that contains global unique identifier values.

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.

FieldLinkPropertyNames

Specifies properties of the SP.FieldLink Class.

FieldLookup

Specifies a lookup field.

FieldLookupPropertyNames

Specifies properties of the SP.FieldLookup Class.

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.

FieldMultiChoicePropertyNames

Specifies properties of the SP.FieldMultiChoice Class.

FieldMultiLineText

Specifies a field that can contain multiple lines of text.

FieldMultiLineTextPropertyNames

Specifies properties of the SP.FieldMultiLineText Class.

FieldNumber

Specifies a field that contains number values.

FieldNumberPropertyNames

Specifies properties of the SP.FieldNumber Class.

FieldPropertyNames

Specifies properties of the SP.Field Class.

FieldRatingScale

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

FieldRatingScalePropertyNames

Specifies properties of the SP.FieldRatingScale Class.

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.

FieldTextPropertyNames

Specifies properties of the SP.FieldTextPropertyNames Class.

FieldUrl

Specifies a field that contains a URI.

FieldUrlPropertyNames

Specifies properties of the SP.FieldUrl Class.

FieldUrlValue

Specifies the hyperlink and the description values for FieldURL.

FieldUser

Specifies a field that contains a user.

FieldUserPropertyNames

Specifies properties of the SP.FieldUser Class.

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 Class objects.

FileObjectPropertyNames

Specifies properties of the SP.File Class.

FilePropertyNames

Specifies properties of the SP.File Class.

FileVersion

Represents a version of a SP.File Class object.

FileVersionCollection

Represents a collection of SP.FileVersion Class objects.

FileVersionObjectPropertyNames

Specifies properties of the SP.FileVersion Class.

FileVersionPropertyNames

Specifies properties of the SP.FileVersion Class.

Folder

Represents a folder on a SharePoint Web site.

FolderCollection

Represents a collection of SP.Folder Class objects.

FolderObjectPropertyNames

Specifies properties of the SP.Folder Class.

FolderPropertyNames

Specifies properties of the SP.Folder Class.

Form

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

FormCollection

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

FormPropertyNames

Specifies properties of the SP.Form Class.

Group

Represents a group on a Microsoft SharePoint Foundation Web site.

GroupCollection

Represents a collection of SP.Group Class objects.

GroupCreationInformation

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

GroupObjectPropertyNames

Specifies properties of the SP.Group Class.

GroupPropertyNames

Specifies properties of the SP.Group Class.

Guid

Represents a globally unique identifier (GUID).

IFromJson

Represents JavaScript Object Notation (JSON) data from the server used to initialize an object.

List

Represents a list on a SharePoint Web site.

ListCollection

Represents a collection of SP.List Class 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 Class objects.

ListItemCollectionPosition

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

ListItemCollectionPropertyNames

Specifies properties of the SP.ListItemCollection Class.

ListItemCreationInformation

Specifies the properties of the new list item.

ListItemObjectPropertyNames

Specifies properties of the SP.ListItem Class.

ListItemPropertyNames

Specifies properties of the SP.ListItem Class class.

ListObjectPropertyNames

Specifies properties of the SP.List Class.

ListPropertyNames

Specifies properties of the SP.List Class.

ListTemplate

Specifies a list template.

ListTemplateCollection

Represents a collection of SP.ListTemplate Class objects.

ListTemplatePropertyNames

Specifies properties of the SP.ListTemplate Class.

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 Class objects.

NavigationNodeCreationInformation

Describes a new navigation node to be created.

NavigationNodeObjectPropertyNames

Specifies properties of the SP.NavigationObjectPropertyNames Class.

NavigationNodePropertyNames

Specifies properties of the SP.NavigationNode Class.

NavigationObjectPropertyNames

Specifies properties of the SP.ObjectPath Class.

NavigationPropertyNames

Specifies properties of the SP.Navigation Class.

ObjectIdentityQuery

This class and its members are reserved for internal use and are not intended to be used in your code. Creates the client object identity query that is used to retrieve the object identity from the server.

ObjectPath

Tracks how a client object is created in the SP.ClientRuntimeContext Class, so that the object can be re-created on the server. This class and its members are reserved for internal use and are not intended to be used in your code.

ObjectPathConstructor

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

ObjectPathIdentity

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

ObjectPathMethod

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

ObjectPathProperty

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

ObjectPathStaticMethod

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

ObjectPathStaticProperty

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

OfficeVersion

Represents the version information of Office products for Microsoft SharePoint Server.

PageContextInfo

Represents the context associated with a page.

PageRequest

Represents a page request.

PageRequestFailedEventArgs

Provides data for the exception handling method when an SP.PageRequest Class execution fails.

PageRequestSucceededEventArgs

Provides data for the handling method when an SP.PageRequest Class execution succeeds.

Principal

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

PrincipalPropertyNames

Specifies properties of the SP.Principal Class.

PropertyValues

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

RecycleBinItem

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

RecycleBinItemCollection

Specifies a collection of SP.RecycleBinItem Class objects.

RecycleBinItemObjectPropertyNames

Specifies properties of the SP.RecycleBinItem Class.

RecycleBinItemPropertyNames

Specifies properties of the SP.RecycleBinItem Class.

RelatedField

Specifies a relationship to a lookup field.

RelatedFieldCollection

Specifies a collection of SP.RelatedField Class 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.

RelatedFieldExtendedDataPropertyNames

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

RelatedFieldObjectPropertyNames

Specifies properties of the SP.RelatedField Class.

RelatedFieldPropertyNames

Specifies properties of the SP.RelatedField Class.

RequestContext

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

RequestContextObjectPropertyNames

Specifies properties of the SP.RequestContext Class.

Result

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

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 Class objects that defines all the role assignments for each securable object.

RoleAssignmentObjectPropertyNames

Specifies properties of the SP.RoleAssignment Class.

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 Class 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.

RoleDefinitionPropertyNames

Specifies properties of the SP.RoleDefinition Class.

ScriptUtility

Provides methods and an emptyString field for working with ECMA scripts.

SecurableObject

An object that can be assigned security permissions.

SecurableObjectObjectPropertyNames

Specifies properties of the SP.SecurableObject Class.

SecurableObjectPropertyNames

Specifies properties of the SP.SecurableObject Class.

SerializationContext

Stores the SP.ObjectPath Class information of the client object to transmit the path to the server This class and its members are reserved for internal use and are not intended to be used in your code..

Site

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

SiteObjectPropertyNames

Specifies properties of the SP.Site Class.

SitePropertyNames

Specifies properties of the SP.Site Class.

SOD

Represents an on-demand ECMA script.

StreamRowCounters

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

SubwebQuery

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

Ticks

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

TimerResetCheck

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

ULS

Provides a Unified Logging Service (ULS) that monitors log messages.

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 Class objects.

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 Class objects.

UserCustomActionPropertyNames

Specifies properties of the SP.UserCustomAction Class.

UserPropertyNames

Specifies properties of the SP.User Class.

View

Specifies a list view.

ViewCollection

Specifies a collection of list views.

ViewCreationInformation

Specifies the properties used to create a new list view.

ViewFieldCollection

Specifies the collection of fields in a list view.

ViewFieldCollectionPropertyNames

Specifies properties of the SP.ViewFieldCollection Class.

ViewObjectPropertyNames

Specifies properties of the SP.View Class.

ViewPropertyNames

Specifies properties of the SP.View Class.

Web

Represents a Microsoft SharePoint Foundation Web site.

WebCollection

Represents a collection of SP.Web Class objects.

WebCreationInformation

Specifies the properties of a new site.

WebObjectPropertyNames

Specifies properties of the SP.Web Class.

WebPropertyNames

Specifies properties of the SP.Web Class.

WebTemplate

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

WebTemplateCollection

Specifies a collection of site templates.

WebTemplatePropertyNames

Specifies properties of the SP.WebTemplate Class.

WsaStreamRow

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

XmlWriter

Defines a writer that provides a set of methods to append text in XML format.

Enumerations

Name

Description

AddFieldOptions

Specifies the control settings while adding a field.

BaseType

Specifies the base type for a list.

BrowserFileHandling

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

BWsaStreamTypes

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.

ClientRequestStatus

Specifies the status of the client request during execution.

CustomizedPageStatus

Specifies the cache and customization status for a page.

DateTimeFieldFormatType

Specifies the display format for date and time fields.

DateTimeKind

Specifies whether an instant in time represents a local time, a Coordinated Universal Time (UTC), or neither local time nor UTC.

DraftVisibilityType

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

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.

PermissionKind

Specifies permissions that are used to define user roles.

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.

SQMDP

Specifies the value of the datapoint ID for Software Quality Metrics (SQM).

TemplateFileType

Specifies the type of template used for ghosted file creation.

ULSTraceLevel

Indicates the amount of detail in a trace message.

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.