EditorPart.ApplyChanges 方法

  • 参考

定义

命名空间:
System.Web.UI.WebControls.WebParts
程序集:
System.Web.dll

将 EditorPart 控件中的值保存到关联 WebPart 控件的相应属性。

public:
 abstract bool ApplyChanges();
public abstract bool ApplyChanges ();
abstract member ApplyChanges : unit -> bool
Public MustOverride Function ApplyChanges () As Boolean

返回

Boolean

如果将值从 EditorPart 控件保存到 WebPart 控件的操作成功，则为 true；否则（如果出现错误）为 false。

示例

下面的代码示例演示如何在自定义EditorPart控件中实现 ApplyChanges 方法。 有关运行该示例所需的完整代码，请参阅类概述的 EditorPart “示例”部分。

代码示例的第一部分演示了方法在名为 TextDisplayEditorPart的ApplyChanges自定义EditorPart类中的实现。 此方法使用 属性获取对关联 TextDisplayWebPart 控件的 WebPartToEdit 引用。 然后，它会更新 属性的值 TextDisplayWebPart.FontStyle 。

public override bool ApplyChanges()
{
  TextDisplayWebPart part = 
    (TextDisplayWebPart)WebPartToEdit;
  // Update the custom WebPart control with the font style.
  part.FontStyle = PartContentFontStyle.SelectedValue;

  return true;
}

Public Overrides Function ApplyChanges() As Boolean
  Dim part As TextDisplayWebPart = CType(WebPartToEdit, _
                                         TextDisplayWebPart)
  ' Update the custom WebPart control with the font style.
  part.FontStyle = PartContentFontStyle.SelectedValue

  Return True

End Function

代码示例的第二部分演示了关联的 WebPart 控件 TextDisplayWebPart如何创建关联 EditorPart 控件的集合， (在本例中，集合中只有一个名为 EditorPartTextDisplayEditorPart 的控件) 方法的 CreateEditorParts 实现中。 此方法在控件进入编辑模式时 TextDisplayWebPart 执行。

public override EditorPartCollection CreateEditorParts()
{
  ArrayList editorArray = new ArrayList();
  TextDisplayEditorPart edPart = new TextDisplayEditorPart();
  edPart.ID = this.ID + "_editorPart1";
  editorArray.Add(edPart);
  EditorPartCollection editorParts = 
    new EditorPartCollection(editorArray);
  return editorParts;
}

public override object WebBrowsableObject
{
  get { return this; }
}

Public Overrides Function CreateEditorParts() _
                            As EditorPartCollection
  Dim editorArray As New ArrayList()
  Dim edPart as New TextDisplayEditorPart()
  edPart.ID = Me.ID & "_editorPart1"
  editorArray.Add(edPart)
  Dim editorParts As New EditorPartCollection(editorArray)
  Return editorParts

End Function

Public Overrides ReadOnly Property WebBrowsableObject() _
                                    As Object
  Get
    Return Me
  End Get
End Property

注解

方法 ApplyChanges 是控件上 EditorPart 的关键方法。 它在 类中 EditorPart 定义为抽象方法，必须由继承的控件实现。 该方法的目的是将用户在 控件中 EditorPart 输入的值保存到 属性中引用的 WebPart 控件中的 WebPartToEdit 相应属性。

ApplyChanges当用户在编辑用户界面 (UI) 中单击表示 OK 或应用谓词的按钮时，将调用 方法。

实施者说明

派生自 类的 EditorPart 类必须实现 ApplyChanges() 方法。 实现的方法使用 WebPartToEdit 属性获取对关联控件的引用，然后使用控件中的当前值更新该控件的属性 EditorPart 。

适用于

另请参阅