Class RadzenToc
Displays a table of contents for a page.
Inherited Members
Namespace: Radzen.Blazor
Assembly: Radzen.Blazor.dll
Syntax
public class RadzenToc : RadzenComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable, IAsyncDisposableConstructors
RadzenToc()
Displays a table of contents for a page.
Declaration
public RadzenToc()Properties
ChildContent
Gets or sets the child content.
Declaration
[Parameter]
public RenderFragment? ChildContent { get; set; }Property Value
| Type | Description |
|---|---|
| RenderFragment |
Orientation
Gets or sets the orientation of the table of contents.
Declaration
[Parameter]
public Orientation Orientation { get; set; }Property Value
| Type | Description |
|---|---|
| Orientation |
Selector
Gets or sets the CSS selector of the element to monitor for scroll events. By default the entire page is monitored.
Declaration
[Parameter]
public string? Selector { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Methods
BuildRenderTree(RenderTreeBuilder)
Displays a table of contents for a page.
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)Parameters
| Type | Name | Description |
|---|---|---|
| RenderTreeBuilder | __builder |
Overrides
DisposeAsync()
Displays a table of contents for a page.
Declaration
public ValueTask DisposeAsync()Returns
| Type | Description |
|---|---|
| ValueTask |
GetComponentCssClass()
Gets the component CSS class.
Declaration
protected override string GetComponentCssClass()Returns
| Type | Description |
|---|---|
| string |
Overrides
OnAfterRenderAsync(bool)
Called by the Blazor runtime.
Declaration
protected override Task OnAfterRenderAsync(bool firstRender)Parameters
| Type | Name | Description |
|---|---|---|
| bool | firstRender |
Returns
| Type | Description |
|---|---|
| Task |
Overrides
ScrollIntoView(string)
Invoked when the current toc item changes.
Declaration
[JSInvokable]
public void ScrollIntoView(string selector)Parameters
| Type | Name | Description |
|---|---|---|
| string | selector |