SPView Component

Properties Methods Events Configuration Settings Errors

Manages views for a SharePoint list.

Syntax

nsoftware.InSP.Spview

Remarks

The SPView component provides a simple way to add, update, and delete views for a SharePoint list.

To add a view specify a few properties such as List, ViewFields, ViewName, and ViewType then call AddView.

Updating a view can be achieved by calling UpdateView and will allow you to modify a number of view settings including ViewFields, ViewName, ViewType, Query, ViewIsDefault, and more.

To list all of the views for a List simply call ListViews method and monitor the ViewList event. Deleting a view is a simple as setting ViewId and calling DeleteView.

Property List

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


AuthScheme	The authentication scheme to be used while authenticating with the server.
Firewall	A set of properties related to firewall access.
Idle	The current status of the component.
List	The name or Id of the list.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
Password	The password to use for authentication.
Proxy	A set of properties related to proxy access.
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during SSL negotiation.
SSLServerCert	The server certificate for the last established connection.
Timeout	A timeout for the component.
URL	The base URL for the site.
User	The user account to use for authentication.
ViewFields	A comma separated list of included fields.
ViewId	The unique ID of the view.
ViewIsDefault	Specifies if the current view is the default.
ViewName	The display name of the view.
ViewQuery	The CAML query associated with the view.
ViewType	The type of view.
ViewURL	The relative URL of the view.

Method List

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


AddView	Adds a new view.
Config	Sets or retrieves a configuration setting .
DeleteView	Deletes the specified view.
DoEvents	Processes events from the internal message queue.
GetViewInfo	Retrieves information about the view.
GetXAttribute	Retrieve the value at the specified XPath in the SOAP response.
Interrupt	Interrupt the current method.
ListViews	Lists all the views of a list.
Reset	Resets request-related properties.
SendCustomRequest	Sends a custom request to the server.
UpdateView	Updates the view.

Event List

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


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.
ViewList	Fired for each view.

Configuration Settings

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


RowLimit	The row limit of the view.
CalendarViewData	Additional view data.
CalendarViewStyles	Calendar view style information.
RawEntry	Returns the raw entry for the view.
StoreViews	If true, store the views when ListViews is called.
ViewCount	The number of views of the list specified by List.
ViewId[i]	The unique identifier of the view at index 'i'.
ViewIsDefault[i]	Indicates if the view at index 'i' is the default view.
ViewName[i]	The display name of the view at index 'i'.
ViewType[i]	The type of the view at index 'i'.
ViewURL[i]	The relative URL of the view at index 'i'.
SOAPRequest	The contents of the request sent to the server.
SOAPResponse	The response from the last request.
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.