WebPart.PartCacheWrite-Methode

Artikel
05/06/2015

Speichert den angegebenen Wert des angegebenen Typs des Speichers im Cache-Webpart.

Namespace: Microsoft.SharePoint.WebPartPages
Assembly: Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Protected Sub PartCacheWrite ( _
    storage As Storage, _
    key As String, _
    value As Object, _
    timeout As TimeSpan _
)
'Usage
Dim storage As Storage
Dim key As String
Dim value As Object
Dim timeout As TimeSpan

Me.PartCacheWrite(storage, key, value, _
    timeout)

protected void PartCacheWrite(
    Storage storage,
    string key,
    Object value,
    TimeSpan timeout
)

Parameter

storage
Typ: Microsoft.SharePoint.WebPartPages.Storage

Ein Storage -Wert, der in der Webpartcache Speichertyp angibt, in dem ein Wert gespeichert ist. Mögliche Werte sind Personal und Shared. Angeben von None speichert Nothing zurück.

key
Typ: System.String

Der Name, der als Schlüssel für den Wert verwendet werden, in der Webpart-Cache gespeichert werden sollen.

value
Typ: System.Object

Eine System.Object , die den zu speichernden Wert enthält.

timeout
Typ: System.TimeSpan

Eine System.TimeSpan , die den Zeitraum angibt, während, den PartCacheWrite versucht, einen Wert zu schreiben.

Hinweise

Wenn die CacheType CacheObjectist, kann alle Objekte im Cache gespeichert werden. Wenn die CacheType Databaseist, muss das Objekt als serializable (System.SerializableAttribute) gekennzeichnet sein.

Beispiele

Das folgende Codebeispiel zeigt ein Webpart, das zwischengespeichert und die Uhrzeit, wann es wird zum ersten Mal gerendert und bietet eine Schaltfläche zum Aktualisieren des Caches-Webpart mit der aktuellen Zeit, anzeigt.

Imports System
Imports System.ComponentModel
Imports System.Web.UI
Imports System.Web.UI.WebControls
Imports System.Xml.Serialization
Imports Microsoft.SharePoint
Imports Microsoft.SharePoint.Utilities
Imports Microsoft.SharePoint.WebPartPages

Namespace WebPartLibrary1
    <DefaultProperty("Text"), _
    ToolboxData("<{0}:CacheSample runat=server></{0}:CacheSample>"), _
    XmlRoot([Namespace] := "WebPartLibrary1")>
   Public Class CacheSample
      
      Inherits Microsoft.SharePoint.WebPartPages.WebPart
      Private refreshButton As Button
            
      Public Sub New()
         AddHandler Me.PreRender, AddressOf UpdateCache
      End Sub
            
      Protected Overrides Sub CreateChildControls()
         refreshButton = New Button()
         refreshButton.Text = "Refresh Cache"
         AddHandler refreshButton.Click, AddressOf refreshButton_click
         Me.Controls.Add(refreshButton)
      End Sub
            
      Public Sub UpdateCache(o As Object, e As System.EventArgs)
         
         If Me.PartCacheRead(Storage.Shared, "cacheKey") Is Nothing Then
            Me.PartCacheWrite(Storage.Shared, "cacheKey", fetchData(), TimeSpan.FromSeconds(10))
         End If
      End Sub
            
      Private Sub refreshButton_click(o As Object, e As System.EventArgs)
         Me.PartCacheInvalidate(Storage.Shared, "cacheKey")
      End Sub
            
      Protected Overrides Sub RenderWebPart(output As HtmlTextWriter)
         output.Write("Cache Value: ")
         output.Write((PartCacheRead(Storage.Shared, "cacheKey") + "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;"))
         Me.RenderChildren(output)
      End Sub
            
      Private Function fetchData() As String
         Return DateTime.Now.ToLongTimeString()
      End Function
   End Class
End Namespace

using System;
using System.ComponentModel;
using System.Web.UI;
using System.Web.UI.WebControls;
using System.Xml.Serialization;
using Microsoft.SharePoint;
using Microsoft.SharePoint.Utilities;
using Microsoft.SharePoint.WebPartPages;

namespace WebPartLibrary1
{
    /// <summary>
    /// Summary description for CacheSample.
    /// </summary>
    [DefaultProperty("Text"),
        ToolboxData("<{0}:CacheSample runat=server></{0}:CacheSample>"),
        XmlRoot(Namespace="WebPartLibrary1")]

    public class CacheSample : Microsoft.SharePoint.WebPartPages.WebPart
    {
        Button refreshButton;

        public CacheSample()
        {
            this.PreRender+=new EventHandler(UpdateCache);
        }

        protected override void CreateChildControls()
        {
            refreshButton = new Button();
            refreshButton.Text="Refresh Cache";
            refreshButton.Click+=new EventHandler(refreshButton_click);
            this.Controls.Add(refreshButton);
        }

        public void UpdateCache(object o, System.EventArgs e)
        {

            if(this.PartCacheRead(Storage.Shared,"cacheKey") == null)
            {
                this.PartCacheWrite(Storage.Shared,"cacheKey", fetchData(), TimeSpan.FromSeconds(10));
            }
        }

        private void refreshButton_click(object o, System.EventArgs e)
        {
            this.PartCacheInvalidate(Storage.Shared, "cacheKey");
        }

        protected override void RenderWebPart(HtmlTextWriter output)
        {
            output.Write("Cache Value: ");
            output.Write(PartCacheRead(Storage.Shared,"cacheKey")+ "&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;");
            this.RenderChildren(output);
        }

        private string fetchData()
        {
            return DateTime.Now.ToLongTimeString();
        }
    }
}

Siehe auch

Referenz

WebPart Klasse

WebPart-Member

Microsoft.SharePoint.WebPartPages-Namespace

Share via