#region 程序集 System.Web.WebPages, Version=3.0.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35
// D:work-XNYXNYWebpackagesMicrosoft.AspNet.Webpages.3.2.3lib
et45System.Web.Webpages.dll
#endregion
using System.Collections.Generic;
using System.IO;
using System.Runtime.CompilerServices;
namespace System.Web.WebPages
{
//
// 摘要:
// 充当表示 ASP.NET Razor 页的类的基类。
public abstract class WebPageBase : WebPageRenderingBase
{
//
// 摘要:
// 初始化 System.Web.WebPages.WebPageBase 类以供继承的类实例使用。此构造函数只能由继承的类调用。
protected WebPageBase();
//
// 摘要:
// 对页面、布局页和分页之间共享的页数据提供类似属性的访问。
//
// 返回结果:
// 一个包含页数据的对象。
[Dynamic]
public override dynamic Page { get; }
//
// 摘要:
// 获取当前页上下文的 System.IO.TextWriter 对象的堆栈。
//
// 返回结果:
// System.IO.TextWriter 对象。
public Stack<TextWriter> OutputStack { get; }
//
// 摘要:
// 获取页面当前的 System.IO.TextWriter 对象。
//
// 返回结果:
// System.IO.TextWriter 对象。
public TextWriter Output { get; }
//
// 摘要:
// 对页面、布局页和分页之间共享的页数据提供类似数组的访问。
//
// 返回结果:
// 一个包含页数据的字典。
[Dynamic(new[] { false, false, true })]
public override IDictionary<object, dynamic> PageData { get; }
//
// 摘要:
// 获取或设置布局页的路径。
//
// 返回结果:
// 布局页的路径。
public override string Layout { get; set; }
//
// 摘要:
// 使用指定的虚拟路径创建 System.Web.WebPages.WebPageBase 类的新实例。
//
// 参数:
// virtualPath:
// 要用于创建实例的虚拟路径。
//
// 返回结果:
// 新的 System.Web.WebPages.WebPageBase 对象。
public static WebPageBase CreateInstanceFromVirtualPath(string virtualPath);
//
// 摘要:
// 由内容页调用以创建指定的内容部分。
//
// 参数:
// name:
// 要创建的部分的名称。
//
// action:
// 在新部分中要执行的操作的类型。
public void DefineSection(string name, SectionWriter action);
//
// 摘要:
// 使用指定的参数，在一组相关的网页中执行代码。
//
// 参数:
// pageContext:
// 页的上下文数据。
//
// writer:
// 要用于编写执行 HTML 的编写器。
public void ExecutePageHierarchy(WebPageContext pageContext, TextWriter writer);
//
// 摘要:
// 使用指定的上下文、编写器和起始页，在一组相关的网页中执行代码。
//
// 参数:
// pageContext:
// 页的上下文数据。
//
// writer:
// 要用于编写执行 HTML 的编写器。
//
// startPage:
// 在页层次结构中开始执行的页。
public void ExecutePageHierarchy(WebPageContext pageContext, TextWriter writer, WebPageRenderingBase startPage);
//
// 摘要:
// 在一组相关的网页中执行代码。
public override void ExecutePageHierarchy();
//
// 摘要:
// 返回一个值，该值指示是否在页中定义了指定部分。
//
// 参数:
// name:
// 要搜索的部分的名称。
//
// 返回结果:
// 如果在页中定义了指定部分，则为 true；否则为 false。
public bool IsSectionDefined(string name);
//
// 摘要:
// 从 System.Web.WebPages.WebPageBase.OutputStack 实例顶部返回并移除上下文。
public void PopContext();
//
// 摘要:
// 在 System.Web.WebPages.WebPageBase.OutputStack 实例顶部插入指定的上下文。
//
// 参数:
// pageContext:
// 要推送到 System.Web.WebPages.WebPageBase.OutputStack 实例上的页上下文。
//
// writer:
// 页上下文的编写器。
public void PushContext(WebPageContext pageContext, TextWriter writer);
//
// 摘要:
// 在布局页中，将呈现不在指定部分中的内容页部分。
//
// 返回结果:
// 要呈现的 HTML 内容。
public HelperResult RenderBody();
//
// 摘要:
// 在其他页内呈现某一页的内容。
//
// 参数:
// path:
// 要呈现的页的路径。
//
// data:
// （可选）要传递给所呈现页的数据数组。在所呈现页中，可以使用 System.Web.WebPages.WebPageBase.PageData 属性来访问这些参数。
//
// 返回结果:
// 要呈现的 HTML 内容。
public override HelperResult RenderPage(string path, params object[] data);
//
// 摘要:
// 在布局页中，将呈现指定部分的内容并指定该部分是否为必需。
//
// 参数:
// name:
// 要呈现的部分。
//
// required:
// 要指定该部分为必需，则为 true；否则为 false。
//
// 返回结果:
// 要呈现的 HTML 内容。
public HelperResult RenderSection(string name, bool required);
//
// 摘要:
// 在布局页中，将呈现指定部分的内容。
//
// 参数:
// name:
// 要呈现的部分。
//
// 返回结果:
// 要呈现的 HTML 内容。
//
// 异常:
// T:System.Web.HttpException:
// name 部分已呈现。- 或 -name 部分已标记为必需，但却找不到。
public HelperResult RenderSection(string name);
//
// 摘要:
// 将指定的对象作为 HTML 编码的字符串写入。
//
// 参数:
// value:
// 要编码并写入的对象。
public override void Write(object value);
//
// 摘要:
// 将指定的 System.Web.WebPages.HelperResult 对象作为 HTML 编码的字符串写入。
//
// 参数:
// result:
// 要编码并写入的帮助器结果。
public override void Write(HelperResult result);
//
// 摘要:
// 无需先对指定的对象进行 HTML 编码，即可将其写入。
//
// 参数:
// value:
// 要写入的对象。
public override void WriteLiteral(object value);
//
// 摘要:
// 在派生类中重写时，将基于父网页的配置来配置当前网页。
//
// 参数:
// parentPage:
// 要从中读取配置信息的父页。
protected virtual void ConfigurePage(WebPageBase parentPage);
//
// 摘要:
// 尝试从 virtualPath 创建 WebPageBase 实例，并使用较简单的消息包装复杂的编译器异常
protected virtual WebPageBase CreatePageFromVirtualPath(string virtualPath, HttpContextBase httpContext, Func<string, bool> virtualPathExists, DisplayModeProvider displayModeProvider, IDisplayMode displayMode);
//
// 摘要:
// 初始化当前页。
protected virtual void InitializePage();
//
// 摘要:
// 返回用于呈现页面的文本编写器实例。
//
// 返回结果:
// 文本编写器。
protected internal override TextWriter GetOutputWriter();
}
}
