LimitedWebPartManager.AddWebPart 方法
将 Web 部件添加到 Web 部件页中。
命名空间: Microsoft.SharePoint.Client.WebParts
程序集: Microsoft.SharePoint.Client.Silverlight(位于 Microsoft.SharePoint.Client.Silverlight.dll 中); Microsoft.SharePoint.Client.Phone(位于 Microsoft.SharePoint.Client.Phone.dll 中) Microsoft.SharePoint.Client(位于 Microsoft.SharePoint.Client.dll 中)
语法
声明
Public Function AddWebPart ( _
webPart As WebPart, _
zoneId As String, _
zoneIndex As Integer _
) As WebPartDefinition
用法
Dim instance As LimitedWebPartManager
Dim webPart As WebPart
Dim zoneId As String
Dim zoneIndex As Integer
Dim returnValue As WebPartDefinition
returnValue = instance.AddWebPart(webPart, _
zoneId, zoneIndex)
public WebPartDefinition AddWebPart(
WebPart webPart,
string zoneId,
int zoneIndex
)
参数
webPart
类型:Microsoft.SharePoint.Client.WebParts.WebPart要添加到 Web 部件页的 Web 部件。
zoneId
类型:System.String要向其中添加 Web 部件的 Web 部件区域的名称。
zoneIndex
类型:System.Int32指定 Web 部件区域内将在其中插入 Web 部件的位置的 Web 部件区域索引。
返回值
类型:Microsoft.SharePoint.Client.WebParts.WebPartDefinition
返回WebPartDefinition实例,表示在 Web 部件区域内将在其中插入 Web 部件的位置。
异常
异常 | 条件 |
---|---|
[System.UnauthorizedAccessException] | 当前用户没有足够的权限。错误代码 ︰ 为-2147024891 |
备注
用户范围时,当前用户必须有权限添加和删除个性化的 Web 部件。当共享范围时,当前用户必须以自定义页面的权限。另请参阅 ︰ ImportWebPart 下, 一节中的。使用 ImportWebPart 导入 Web 部件,然后使用 AddWebPart 以将其添加到 Web 部件页。每个 Web 部件区域必须具有一个唯一名称。它不能空引用(无 在 Visual Basic 中)。它不为空。其长度必须等于或小于 64。
直接在现有的 Web 部件的最低的 Web 部件区域索引大于或等于 zoneIndex 之前,必须插入新的 Web 部件。如果 zoneIndex 大于区域中的所有 Web 部件的索引,或者没有 Web 部件在 Web 部件区域,必须在 Web 部件区域的结尾处插入新的 Web 部件。其值必须等于或大于 0。