DataViewWebPart Class

The DataViewWebPart class provides runtime support for data retrieval and presentation in Microsoft Office FrontPage 2003.

Microsoft.SharePoint.WebPartPages.WebPart

   Microsoft.SharePoint.WebPartPages.DataViewWebPart

Public Constructors

The following table shows the constructors of the DataViewWebPart class and a brief description of each.

Name Description
DataViewWebPart Initializes a new instance of the DataViewWebPart class.

Events

The following table shows the events of the DataViewWebPart class and a brief description of each.

Name Description
FilterConsumerInit Occurs when a connection is established with a Web Part that implements the IFilterConsumer interface.
ParametersInConsumerInit Occurs when a connection is established with a Web Part that implements the IParametersInConsumer interface.
RowProviderInit Occurs when a connection is established with a Web Part that implements the IRowProvider interface.
RowReady Occurs when the selected row changes, such as when a row is updated or selected.

Public Methods

The following table shows the public methods of the DataViewWebPart class and a brief description of each.

Name Description
AfterDeserialize Overrides the Microsoft.SharePoint.WebPartPages.WebPart.AfterDeserialize method.
CanRunAt Overrides the Microsoft.SharePoint.WebPartPages.WebPart.CanRunAt method.
ClearFilter(object, System.EventArgs) Implements the ClearFilter event handler.
DSPGatherDSPAndQuery(System.Xml.XmlDocument, System.Xml.XmlNamespaceManager, Microsoft.SharePoint.SPWeb, bool, Microsoft.SharePoint.Dsp.IDspAdapter, Microsoft.SharePoint.Dsp.QueryRequest, string) Returns the IDSPAdapter and QueryRequest objects based on the input data query XML.
EnsureInterfaces Overrides the Microsoft.SharePoint.WebPartPages.WebPart.EnsureInterfaces method.
GetData Overrides the Microsoft.SharePoint.WebPartPages.WebPart.GetData method.
GetDesignTimeHtml Gets the HTML that is used to represent the control at design time.
GetInitEventArgs(String) Overrides the Microsoft.SharePoint.WebPartPages.WebPart.GetInitEventArgs method. Called by the part to part communication runtime to gather supported interface information for this Web Part.
GetRequiresData Indicates whether this Web Part needs data during this round of communication.
GetToolParts Determines which tool parts are displayed in the tool pane of the web-based Web Part design user interface and the order in which they are displayed.
LoadResource(String) Overrides the Microsoft.SharePoint.WebPartPages.WebPart.LoadResource method.
NoFilter(object, System.EventArgs) Implements the NoFilter event handler.
NoParametersIn(object, System.EventArgs) Provides an event handler for the NoParametersIn event that is fired by the data provider.
ParametersInReady(object, Microsoft.SharePoint.WebPartPages.Communication.ParametersInReadyEventArgs) Implements the ParametersInReady event handler.
PartCommunicationConnect(String, Microsoft.SharePoint.WebPartPages.WebPart, String, Microsoft.SharePoint.WebPartPages.Communication.ConnectionRunAt) Notifies other Web Parts that this Web Part has a connected interface, where that interface should run, and what that interface is connected to.
PartCommunicationInit Runs event handlers for server-side Init events.
PartCommunicationMain Runs event handlers for server-side events for this Web Part.
RaisePostBackEvent(String) Is called by ASP.NET when when this Web Part does a postback to itself.
SetFilter(object, Microsoft.SharePoint.WebPartPages.Communication.SetFilterEventArgs) Implements the SetFilter event handler.
ShouldSerializeCacheDataStorageProperty Indicates whether the CacheDataStorageProperty property should be persisted.
ShouldSerializeCacheDataTimeout Indicates whether the CacheDataTimeout property should be persisted.
ShouldSerializeCacheXslStorageProperty Indicates whether the CacheXslStorageProperty property should be persisted.
ShouldSerializeDataFields Indicates whether the DataFields property should be persisted.
ShouldSerializeDataQueryNode Indicates whether the DataQueryNode property should be persisted.
ShouldSerializeDefault Indicates whether the Default property should be persisted.
ShouldSerializeDisplayName Indicates whether the DisplayName property should be persisted.
ShouldSerializeListName Indicates whether the ListName property should be persisted.
ShouldSerializeNoDefaultStyle Indicates whether the NoDefaultStyle property should be persisted.
ShouldSerializeParameterBindingsNode Indicates whether the ParameterBindingsNode property should be persisted.
ShouldSerializeViewFlag Indicates whether the ViewFlag property should be persisted.
ShouldSerializeXslLink Indicates whether the XslLink property should be persisted.
ShouldSerializeXslNode Indicates whether the XslNode property should be persisted.

Protected Methods

The following table shows the protected methods of the DataViewWebPart class and a brief description of each.

Name Description
RenderWebPart(System.Web.UI.HtmlTextWriter) Overrides the Microsoft.SharePoint.WebPartPages.WebPart.RenderWebPartmethod to implement rendering for this Web Part.

Public Properties

The following table shows the public properties of the DataViewWebPart class, the data type of each property, and a brief description of each.

Name Data type Description
CacheDataStorageProperty Microsoft.SharePoint.WebPartPages.CacheDataStorage enumeration Indicates the type of cache to use when caching data for a data view.
CacheDataTimeout Integer Determines the length of time that elapses before the cache expires.
CacheXslStorageProperty Boolean Determines whether XSL caching is done
DataFields String Gets and sets persisted fields in the RowPath of the top-most DVT template.
DataQuery String Gets and sets the XML that specifies which data retrieval service adapter to use for data retrieval and the query that is passed to the adapter.
DataQueryNode System.Xml.XmlNode Gets and sets the DataQuery property as XML.
Default String Gets and sets persisted fields for the view flag.
DisplayName String Gets and sets persisted fields for the view display name.
FireInitialRow Boolean Gets and sets a flag that indicates whether to fire the first row of data.
IsPrivilegedUser Boolean Indicates whether the user is a member of the Administrator site group for the site.
ListName String Gets and sets the list name.
NoDefaultStyle String Gets and sets a flag that indicates the DVWP for this Web Part does not use default styles.
ParameterBindings String Gets and sets XSL and DataQuery parameter descriptions.
ParameterBindingsNode System.Xml.XmlNode Gets and sets the parameter bindings node.
ViewFlag String Gets and sets persisted fields for the view flag.
Xsl String Gets and sets the XSL that is used to render the presentation of the Web Part.
XslLink String Gets and sets a link to the XSL file that is used to render the presentation of the Web Part.
XslNode System.Xml.XmlNode Gets and sets the embedded XSL that is used to render the presentation of this Web Part.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread safe.

Requirements

Namespace: Microsoft.SharePoint.WebPartPages

Platforms: Microsoft Windows Server 2003

Assembly: Windows SharePoint Services (in Microsoft.SharePoint.dll)

Security: Code Access Security