Table of Contents

Class Tab

Namespace
BootstrapBlazor.Components
Assembly
BootstrapBlazor.dll

Tab 组件

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

Constructors

Tab() 

public Tab()

Properties

AdditionalAssemblies

获得/设置 Gets or sets a collection of additional assemblies that should be searched for components that can match URIs.

[Parameter]
public IEnumerable<Assembly>? AdditionalAssemblies { get; set; }

Property Value

IEnumerable<Assembly>

AllowDrag

获得/设置 是否允许拖放标题栏更改栏位顺序，默认为 false

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

Property Value

bool

Body

获得/设置 TabItems 模板

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

Property Value

RenderFragment

ButtonTemplate

获得/设置 按钮模板 默认 null

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

Property Value

RenderFragment

ChildContent

获得/设置 TabItems 模板

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

Property Value

RenderFragment

ClickTabToNavigation

获得/设置 点击 TabItem 时是否自动导航 默认为 false 不导航

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

Property Value

bool

CloseAllTabsText

获得/设置 关闭所有 TabItem 菜单文本

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

Property Value

string

CloseCurrentTabText

获得/设置 关闭当前 TabItem 菜单文本

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

Property Value

string

CloseIcon

获得/设置 关闭标签图标

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

Property Value

string

CloseOtherTabsText

获得/设置 关闭其他 TabItem 菜单文本

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

Property Value

string

DefaultUrl

获得/设置 默认标签页 关闭所有标签页时自动打开此地址 默认 null 未设置

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

Property Value

string

DropdownIcon

获得/设置 下拉菜单标签图标

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

Property Value

string

ExcludeUrls

获得/设置 排除地址支持通配符

[Parameter]
public IEnumerable<string>? ExcludeUrls { get; set; }

Property Value

IEnumerable<string>

Height

获得/设置 组件高度 默认值为 0 高度自动

[Parameter]
public int Height { get; set; }

Property Value

int

IsBorderCard

获得/设置 是否为带边框卡片样式 默认 false

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

Property Value

bool

IsCard

获得/设置 是否为卡片样式

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

Property Value

bool

IsLazyLoadTabItem

获得/设置 懒加载 TabItem, 首次不渲染 默认 false

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

Property Value

bool

IsOnlyRenderActiveTab

获得/设置 是否仅渲染 Active 标签 默认 false

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

Property Value

bool

Items

获得/设置 TabItem 集合

public IEnumerable<TabItem> Items { get; }

Property Value

IEnumerable<TabItem>

Menus

获得/设置 导航菜单集合 默认 null

[Parameter]
public IEnumerable<MenuItem>? Menus { get; set; }

Property Value

IEnumerable<MenuItem>

Remarks

使用自定义布局时，需要 Tab 导航标签显示为菜单项时设置，已内置 Menus 默认 null

NextIcon

获得/设置 下一个标签图标

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

Property Value

string

NotAuthorized

获得/设置 NotAuthorized 模板

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

Property Value

RenderFragment

NotFound

获得/设置 NotFound 模板

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

Property Value

RenderFragment

NotFoundTabText

获得/设置 NotFound 标签文本

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

Property Value

string

OnClickTabItemAsync

获得/设置 点击 TabItem 时回调方法

[Parameter]
public Func<TabItem, Task>? OnClickTabItemAsync { get; set; }

Property Value

Func<TabItem, Task>

OnCloseTabItemAsync

关闭标签页回调方法

[Parameter]
public Func<TabItem, Task<bool>>? OnCloseTabItemAsync { get; set; }

Property Value

Func<TabItem, Task<bool>>

Remarks

返回 false 时不关 TabItem 标签页

OnDragItemEndAsync

获得/设置 拖动标签页结束回调方法

[Parameter]
public Func<TabItem, Task>? OnDragItemEndAsync { get; set; }

Property Value

Func<TabItem, Task>

Placement

获得/设置 组件标签显示位置 默认显示在 Top 位置

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

Property Value

Placement

PreviousIcon

获得/设置 上一个标签图标

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

Property Value

string

ShowClose

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

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

Property Value

bool

ShowExtendButtons

获得/设置 是否显示扩展功能按钮 默认为 false 不显示

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

Property Value

bool

ShowFullScreen

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

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

Property Value

bool

Methods

ActiveTab(TabItem)

设置指定 TabItem 为激活状态

public void ActiveTab(TabItem item)

Parameters

item TabItem

ActiveTab(int)

设置指定 TabItem 为激活状态

public void ActiveTab(int index)

Parameters

index int

AddTab(Dictionary<string, object?>, int?)

添加 TabItem 方法

public void AddTab(Dictionary<string, object?> parameters, int? index = null)

Parameters

parameters Dictionary<string, object>
index int?

AddTab(string, string, string?, bool, bool)

通过 Url 添加 TabItem 标签方法

public void AddTab(string url, string text, string? icon = null, bool active = true, bool closable = true)

Parameters

url string
text string
icon string
active bool
closable bool

BuildRenderTree(RenderTreeBuilder) 

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder RenderTreeBuilder

ClickNextTab()

切换到下一个标签方法

public void ClickNextTab()

ClickPrevTab()

切换到上一个标签方法

public void ClickPrevTab()

CloseAllTabs()

关闭所有标签页方法

public void CloseAllTabs()

CloseCurrentTab()

关闭当前标签页方法

public Task CloseCurrentTab()

Returns

Task

CloseOtherTabs()

关闭其他标签页方法

public void CloseOtherTabs()

DisposeAsync(bool)

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources asynchronously.

protected override ValueTask DisposeAsync(bool disposing)

Parameters

disposing bool

Returns

ValueTask

DragItemCallback(int, int)

拖动 TabItem 回调方法有 JS 调用

[JSInvokable]
public Task DragItemCallback(int originIndex, int currentIndex)

Parameters

originIndex int
currentIndex int

Returns

Task

GetActiveTab()

获得当前活动 Tab

public TabItem? GetActiveTab()

Returns

TabItem

HandlerException(Exception, RenderFragment<Exception>)

HandlerException 错误处理方法

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

Parameters

ex Exception
errorContent RenderFragment<Exception>

Returns

Task

InvokeInitAsync()

call JavaScript method

protected override Task InvokeInitAsync()

Returns

Task

OnAfterRenderAsync(bool) 

protected override Task OnAfterRenderAsync(bool firstRender)

Parameters

firstRender bool

Returns

Task

OnInitialized() 

protected override void OnInitialized()

OnParametersSet() 

protected override void OnParametersSet()

RemoveTab(TabItem)

移除 TabItem 方法

public Task RemoveTab(TabItem item)

Parameters

item TabItem

Returns

Task