Table of Contents

Class ModalDialog

Namespace
BootstrapBlazor.Components
Assembly
BootstrapBlazor.dll

ModalDialog 组件

public class ModalDialog : BootstrapModuleComponentBase, IComponent, IHandleAfterRender, IHandleEvent, IAsyncDisposable, IHandlerException
Inheritance
ModalDialog
Implements
Inherited Members
Extension Methods

Constructors

ModalDialog() 

public ModalDialog()

Fields

_errorContent

上次渲染错误内容

protected RenderFragment? _errorContent

Field Value

RenderFragment

Properties

BodyContext

获得/设置 弹窗内容相关数据 多用于传值

[Parameter]
public object? BodyContext { get; set; }

Property Value

object

BodyTemplate

获得/设置 ModalBody 组件

[Parameter]
public RenderFragment? BodyTemplate { get; set; }

Property Value

RenderFragment

Class

获得/设置 弹窗自定义样式

[Parameter]
public string? Class { get; set; }

Property Value

string

CloseButtonIcon

获得/设置 关闭按钮显示图标 未设置时 使用 fa-solid fa-fw fa-xmark

[Parameter]
public string? CloseButtonIcon { get; set; }

Property Value

string

CloseButtonText

获得/设置 关闭按钮显示文字 资源文件设置为 关闭

[Parameter]
public string? CloseButtonText { get; set; }

Property Value

string

ExportPdfButtonOptions

获得/设置 导出 Pdf 按钮配置项

[Parameter]
public ExportPdfButtonOptions? ExportPdfButtonOptions { get; set; }

Property Value

ExportPdfButtonOptions

FooterTemplate

获得/设置 ModalFooter 组件

[Parameter]
public RenderFragment? FooterTemplate { get; set; }

Property Value

RenderFragment

FullScreenSize

获得/设置 弹窗大小

[Parameter]
public FullScreenSize FullScreenSize { get; set; }

Property Value

FullScreenSize

GetResultDialog

获得/设置 获得模态弹窗方法 默认 null

[Parameter]
public Func<IResultDialog?>? GetResultDialog { get; set; }

Property Value

Func<IResultDialog>

HeaderTemplate

获得/设置 ModalHeader 组件

[Parameter]
public RenderFragment? HeaderTemplate { get; set; }

Property Value

RenderFragment

HeaderToolbarTemplate

获得/设置 Header 中按钮模板

[Parameter]
public RenderFragment? HeaderToolbarTemplate { get; set; }

Property Value

RenderFragment

IsAutoCloseAfterSave

获得/设置 保存成功后是否自动关闭弹窗 默认 true 自动关闭

[Parameter]
public bool IsAutoCloseAfterSave { get; set; }

Property Value

bool

IsCentered

获得/设置 是否垂直居中 默认为 true

[Parameter]
public bool IsCentered { get; set; }

Property Value

bool

IsDraggable

获得/设置 是否可以拖拽弹窗 默认 false 不可以拖动

[Parameter]
public bool IsDraggable { get; set; }

Property Value

bool

IsScrolling

获得/设置 是否弹窗正文超长时滚动

[Parameter]
public bool IsScrolling { get; set; }

Property Value

bool

MaximizeWindowIcon

获得/设置 最大化按钮图标

[Parameter]
public string? MaximizeWindowIcon { get; set; }

Property Value

string

Modal

获得/设置 弹窗容器实例

[CascadingParameter]
protected Modal? Modal { get; set; }

Property Value

Modal

OnSaveAsync

获得/设置 保存按钮回调委托 返回 true 并且设置 IsAutoCloseAfterSave true 时自动关闭弹窗

[Parameter]
public Func<Task<bool>>? OnSaveAsync { get; set; }

Property Value

Func<Task<bool>>

PrintButtonColor

获得/设置 打印按钮颜色 默认 Color.Primary

[Parameter]
public Color PrintButtonColor { get; set; }

Property Value

Color

PrintButtonIcon

获得/设置 打印按钮图标 未设置 取当前图标主题下打印图标

[Parameter]
public string? PrintButtonIcon { get; set; }

Property Value

string

PrintButtonText

获得/设置 Header 中打印按钮显示文字 默认为资源文件中 打印

[Parameter]
public string? PrintButtonText { get; set; }

Property Value

string

RestoreWindowIcon

获得/设置 恢复按钮图标

[Parameter]
public string? RestoreWindowIcon { get; set; }

Property Value

string

ResultTask

获得/设置 模态弹窗任务 TaskCompletionSource<TResult> 实例 默认 null

[Parameter]
public TaskCompletionSource<DialogResult>? ResultTask { get; set; }

Property Value

TaskCompletionSource<DialogResult>

SaveButtonIcon

获得/设置 保存按钮显示图标 未设置时 使用主题图标

[Parameter]
public string? SaveButtonIcon { get; set; }

Property Value

string

SaveButtonText

获得/设置 保存按钮显示文字 资源文件设置为 保存

[Parameter]
public string? SaveButtonText { get; set; }

Property Value

string

SaveIcon

获得/设置 保存按钮图标

[Parameter]
[Obsolete("已弃用，请使用 SaveButtonIcon; Deprecated, please use SaveButtonIcon")]
public string? SaveIcon { get; set; }

Property Value

string

ShowCloseButton

获得/设置 是否显示关闭按钮 默认为 true 显示

[Parameter]
public bool ShowCloseButton { get; set; }

Property Value

bool

ShowExportPdfButton

获得/设置 是否显示导出 Pdf 按钮 默认为 false 不显示

[Parameter]
public bool ShowExportPdfButton { get; set; }

Property Value

bool

ShowExportPdfButtonInHeader

获得/设置 Header 中是否显示导出 Pdf 按钮 默认 false 不显示

[Parameter]
public bool ShowExportPdfButtonInHeader { get; set; }

Property Value

bool

ShowFooter

获得/设置 是否显示 Footer 默认为 true

[Parameter]
public bool ShowFooter { get; set; }

Property Value

bool

ShowHeader

获得/设置 是否显示 Header 默认为 true

[Parameter]
public bool ShowHeader { get; set; }

Property Value

bool

ShowHeaderCloseButton

获得/设置 是否显示 Header 关闭按钮

[Parameter]
public bool ShowHeaderCloseButton { get; set; }

Property Value

bool

ShowMaximizeButton

获得/设置 是否显示最大化按钮

[Parameter]
public bool ShowMaximizeButton { get; set; }

Property Value

bool

ShowPrintButton

获得/设置 是否显示打印按钮 默认为 false 不显示

[Parameter]
public bool ShowPrintButton { get; set; }

Property Value

bool

ShowPrintButtonInHeader

获得/设置 Header 中是否显示打印按钮 默认 false 不显示

[Parameter]
public bool ShowPrintButtonInHeader { get; set; }

Property Value

bool

ShowResize

获得/设置 是否可以 Resize 弹窗 默认 false

[Parameter]
public bool ShowResize { get; set; }

Property Value

bool

ShowSaveButton

获得/设置 是否显示保存按钮 默认为 false 不显示

[Parameter]
public bool ShowSaveButton { get; set; }

Property Value

bool

Size

获得/设置 弹窗大小

[Parameter]
public Size Size { get; set; }

Property Value

Size

Title

获得/设置 弹窗标题

[Parameter]
public string? Title { get; set; }

Property Value

string

Methods

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

DisposeAsync(bool)

Dispose 方法

protected override ValueTask DisposeAsync(bool disposing)

Parameters

disposing bool

Returns

ValueTask

HandlerException(Exception, RenderFragment<Exception>)

HandlerException 错误处理方法

public virtual Task HandlerException(Exception ex, RenderFragment<Exception> errorContent)

Parameters

ex Exception
errorContent RenderFragment<Exception>

Returns

Task

OnInitialized()

OnInitialized 方法

protected override void OnInitialized()

OnParametersSet()

OnParametersSet 方法

protected override void OnParametersSet()

SetHeaderText(string)

设置 Header 文字方法

public void SetHeaderText(string text)

Parameters

text string