SharePoint Class

Properties Methods Events Configuration Settings Errors

Manages the documents of a Document Library on a SharePoint Server.

Syntax

SharePoint

Remarks

The SPDocuments class allows you to manage SharePoint Documents.

To get started, first set the URL, User, and Password properties to point the class to your Site, and then set DocumentLibrary to the Id of a specific SharePoint Document Library to work with. To retrieve Ids for all of the Document Libraries on your Site, use the SPSITE class.

When List is called, the Document event will fire for each document in the specified library.

To download a document, call Get. Use the Add and AddFolder methods to add documents and folders to the library, and the Delete method to delete documents or folders. To check-out (lock) and check-in documents, use CheckOut and CheckIn. The DiscardCheckout method can be used to abort a previous call to CheckOut without checking-in changes.

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.
DocumentLibrary	The name of the selected document library.
EncryptionAlgorithm	The encryption algorithm.
EncryptionPassword	The encryption password.
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.
LocalFile	The path to a local file for downloading.
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.
VersionCount	The number of records in the Version arrays.
VersionComments	Comments included when this version of the file was checked in.
VersionCreatedBy	The user name of the SharePoint user who modified this version of the file.
VersionDate	A string containing the date and time for this modification of the file.
VersionSize	The size for this version of the file.
VersionURL	The URL of the version.
VersionVersion	A unique version Id assigned to this version of the file by SharePoint.

Method List

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


Add	Adds a document to the library specified by DocumentLibrary .
AddFolder	Adds a folder to the document library.
CheckIn	Checks in a document.
CheckOut	Checks out a document.
Config	Sets or retrieves a configuration setting .
Copy	Copies the specified document to a new location.
Delete	Deletes a document from the library specified by DocumentLibrary .
DiscardCheckout	Discards a checkout lock.
DoEvents	Processes events from the internal message queue.
Get	Retrieves a document from the library specified by DocumentLibrary .
GetId	Retrieve the Document Id of the specified document.
GetXAttribute	Retrieve the value at the specified XPath in the SOAP response.
Interrupt	Interrupt the current method.
List	Lists the documents contained in the specified document library.
ListVersions	Lists the versions of the specified document.
Move	Moves the specified document to a new document library.
Rename	Renames the specified document in the document library.
Reset	Resets request-related properties.
SendCustomRequest	Sends a custom request to the server.

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.


Connected	Fired immediately after a connection completes (or fails).
Disconnected	Fired when a connection is closed.
Document	Fired for each document.
EndTransfer	Fired when a document finishes transferring.
Error	Information about errors during data delivery.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartTransfer	Fired when a document starts transferring (after the headers).
Transfer	Fired while a document transfers (delivers document).
Version	Fired for each version.

Configuration Settings

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


CheckInType	The type of check-in performed.
CheckOutToLocal	Whether the file is to be checked out for offline editting.
DocComment	Used to set the first comment when adding a document.
DocMetaInfo	Specifies the metadata to be associated with a document when it is added.
DocumentAuthor[i]	The author of the document indicated by index i.
DocumentCheckedOutBy[i]	The user who has checked out the document indicated by index i.
DocumentCount	The number of documents returned by a call to List.
DocumentCreated[i]	The date and time the document indicated by index i was created.
DocumentFileName[i]	The filename of the document indicated by index i.
DocumentFileReference[i]	The file reference of the document indicated by index i.
DocumentIsFolder[i]	Whether the document indicated by index i is a folder.
DocumentModified[i]	The date and time the document indicated by index i was last modified.
DocumentSourceControlVersion[i]	The source control version of the document indicated by index i.
DocumentIndex	Selects a document.
DocumentFieldCount	The number of fields for the current document.
DocumentFieldName[i]	The name of the field at the specified index.
DocumentFieldValue[i]	The value of the field at the specified index.
IncludedFields	The fields to request when calling List.
IncludeFieldsWithViewId	Indicates whether to use the IncludedFields setting when using the ViewId setting.
IncludeOrderById	Whether to request that results are ordered by Id when listing documents.
LastModified	A date in RFC 1123 date format representing the date and time of the last modification to the file.
PagingId	Used to check for paged results from SharePoint.
Query	The query to be used while listing documents.
RawEntry	Returns the raw entry for the listing inside.
ResolveLibraryNames	Controls whether or not library names will automatically be resolved.
RowLimit	Limits the rows returned by ListItems.
SiteURL	The complete URL for a service.
Scope	Sets the scope for the View used by the List method.
SOAPResponse	The response from the last request.
SOAPRequest	The contents of the request sent to the server.
StoreDocumentList	Whether or not to store the Documents returned by the List method.
Subfolder	The subfolder of the specified document library.
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.
UseSOAP	Whether to use SOAP or RPC calls for SharePoint operations.
VersionURL	Used to retrieve a specific past version of a document from SharePoint.
ViewID	The GUID of a view to use when listing documents.
EncryptionIV	The initialization vector to be used for encryption/decryption.
EncryptionKey	The key to use during encryption/decryption.
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.