SPSite Class

Properties Methods Events Configuration Settings Errors

Manages the lists and documents for a specific SharePoint Site.

Syntax

SPSite

Remarks

The SPSite component allows you to manage aspects relating to a SharePoint Site. To get started, first set the URL, User, and Password properties to point the class to your Site.

The class can be used to ListLibraries, ListLists, ListTemplates, and ListSubSites of a specific Site. In addition, the AddLibrary, AddList, and DeleteList methods can be used to add and delete Lists and Document Libraries on a Site. Also, the UpdateList method can be used to edit the properties (description and title) of an existing List or Library, and UpdateColumns can be used to edit the columns (schema) of an existing List or Library.

About SharePoint Online Services

When using Microsoft SharePoint Online you must set AuthScheme to authSPOnline (7).

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.


AuthScheme	The authentication scheme to be used while authenticating with the server.
ColumnCount	The number of records in the Column arrays.
ColumnColName	The internal name SharePoint gives to the column.
ColumnType	The type of the column.
ColumnDisplayName	The name that will be displayed while viewing Lists in SharePoint.
ColumnFromBaseType	This flag is used to indicate whether the column is derived from a base type of the parent site.
ColumnHidden	Indicates whether or not the current column is hidden.
ColumnMaxLength	The maximum data length for the column.
ColumnName	The schema name for the column.
ColumnPrimaryKey	If PrimaryKey is set to true, the column will be used as a primary key.
ColumnRawXML	The raw XML content for the column description.
ColumnReadOnly	The ReadOnly property will mark the column as read-only so its contents cannot be modified.
ColumnRequired	If the required property is set to true, the column must have a value.
ColumnUpdateOp	The operation to apply to the current column.
FirewallAutoDetect	This property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallType	This property determines the type of firewall to connect through.
FirewallHost	This property contains the name or IP address of firewall (optional).
FirewallPassword	This property contains a password if authentication is to be used when connecting through the firewall.
FirewallPort	This property contains the TCP port for the firewall Host .
FirewallUser	This property contains a user name if authentication is to be used connecting through a firewall.
Idle	The current status of the component.
Password	The password to use for authentication.
ProxyAuthScheme	This property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetect	This property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPassword	This property contains a password if authentication is to be used for the proxy.
ProxyPort	This property contains the TCP port for the proxy Server (default 80).
ProxyServer	If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSL	This property determines when to use SSL for the connection to the proxy.
ProxyUser	This property contains a user name, if authentication is to be used for the proxy.
SSLAcceptServerCertEncoded	The certificate (PEM/base64 encoded).
SSLCertEncoded	The certificate (PEM/base64 encoded).
SSLCertStore	The name of the certificate store for the client certificate.
SSLCertStorePassword	If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreType	The type of certificate store for this certificate.
SSLCertSubject	The subject of the certificate used for client authentication.
SSLServerCertEncoded	The certificate (PEM/base64 encoded).
Timeout	A timeout for the component.
URL	The base URL for the site.
User	The user account to use for authentication.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.


AddContentType	Adds a new content type to the site.
AddContentTypeToList	Adds the specified content type to the specified list.
AddLibrary	Adds a new document library to the site.
AddList	Adds a new list to the site.
Config	Sets or retrieves a configuration setting .
DeleteContentType	Deletes the specified content type from the site.
DeleteContentTypeFromList	Removes the specified content type.
DeleteList	Deletes the specified list from the site.
DescribeContentType	Describes the schema of a content type.
DescribeList	Describes the schema of a list.
DescribeListContentType	Describes the schema of the list content type.
DoEvents	Processes events from the internal message queue.
GetXAttribute	Retrieve the value at the specified XPath in the SOAP response.
Interrupt	Interrupt the current method.
ListColumns	Lists the columns defined at the site level.
ListContentTypes	Lists all content types on the site.
ListLibraries	Lists all of the document libraries in the current site.
ListListContentTypes	Lists all content types on the list.
ListLists	Lists all lists on the site.
ListSubSites	Lists all of the subsites of the current site.
ListTemplates	Lists all of the templates of the current site.
Reset	Resets request-related properties.
SendCustomRequest	Sends a custom request to the server.
UpdateColumns	Adds, deletes, or updates columns of a site.
UpdateContentType	Updates the specified content type on the site.
UpdateList	Updates a property of a list.
UpdateListColumns	Adds, deletes, or updates columns of a list.
UpdateListContentType	Updates the specified content type on the list.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.


Column	Fired for each column.
ContentType	Fired for each content type.
DocumentLibrary	Fired for each document library.
Error	Information about errors during data delivery.
List	Fired for each list.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
SubSite	Fired for each subsite.
Template	Fired for each template.

Configuration Settings

The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.


IncludeHidden	When true, hidden lists and libraries will be included in the listing.
LibraryCount	The number of Libraries returned by a call to ListLibraries.
LibraryCreated[i]	The date and time the Library indicated by index i was created.
LibraryDescription[i]	The Description of the Library indicated by index i.
LibraryItemCount[i]	The number of Items in the Library indicated by index i.
LibraryModified[i]	The date and time the Library indicated by index i was last modified.
LibraryTitle[i]	The Title of the Library indicated by index i.
RawEntry	Returns the raw entry for the listing inside the List event.
ListCount	The number of Lists returned by a call to ListLists.
ListCreated[i]	The date and time the List indicated by index i was created.
ListDescription[i]	The Description of the List indicated by index i.
ListId[i]	The ID of the List indicated by index i.
ListItemCount[i]	The number of Items in the List indicated by index i.
ListListBaseType[i]	The ListBaseType of the List indicated by index i.
ListListType[i]	The ListType of the List indicated by index i.
ListModified[i]	The date and time the List indicated by index i was last modified.
ListRegionalLanguage	The language ID for a list.
ListRegionalLocale	The locale ID for a list.
ListRegionalCalendarType	The ID for the calendar type used by a list.
ListRegionalTimeZone	The TimeZone code for a list.
ListRegionalSortOrder	The Sort Order ID for a list.
ListTitle[i]	The Title of the List indicated by index i.
ListViewURL[i]	The ViewURL of the List indicated by index i.
StoreLibraryList	Whether or not to store the Document Libraries returned by the ListLibraries method.
StoreListsList	Whether or not to store the Lists returned by the ListLists method.
SiteURL	The complete URL for a service.
SOAPResponse	The response from the last request.
SOAPRequest	The contents of the request sent to the server.
FormBasedCookies	Holds the security cookies for Form-Based Authentication.
SPOnlineSecurityCookies	Holds the security cookies for SharePoint Online.
SPOnlineSSO	Whether to use Single Sign On (SSO) with Active Directory Federation Services (ADFS).
SPOnlineSTS	The URL of the online STS.
SPOnlineADFSAuthScheme	The HTTP authentication scheme used when working with SSO.
SSODomain	Specifies the federation domain configured in Office 365.
ParseCustomResponse	Whether to automatically parse the response from the SendCustomRequest() method.
XPath	Provides a way to point to a specific element in the returned XML response.
XText	The text of the current element.
XElement	The name of the current element.
XNamespace	The namespace of the current element.
XParent	The parent of the current element.
XPrefix	The prefix of the current element.
XSubTree	A snapshot of the current element in the document.
XAttributesCount	The number of attributes of the current element.
XAttributesName[x]	The name of the selected attribute.
XAttributesValue[x]	The attribute value.
XAttributesNamespace[x]	The attribute namespace.
XAttributesPrefix[x]	The attribute prefix.
XChildrenCount	The number of child elements of the current element.
XChildrenName[x]	The name of the child element.
XChildrenXText[x]	The inner text of the child element.
XChildrenNamespace[x]	The namespace of the child element.
XChildrenPrefix[x]	The prefix of the child element.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowIdenticalRedirectURL	Allow redirects to the same URL.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
EncodeURL	If set to true the URL will be encoded by the component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
UserAgent	Information about the user agent (browser).
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.