Skip to content

docs(Scheduler): add refresh method documentation #2628

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 13, 2024
Merged

docs(Scheduler): add refresh method documentation #2628

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
274b025
docs(Scheduler): add refresh method documentation
Tsvetomir-Hr Dec 11, 2024
6bb68e4
chore: apply suggestions
Tsvetomir-Hr Dec 13, 2024
84455e1
Update components/scheduler/overview.md
dimodi Dec 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions components/scheduler/overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,37 @@ The following table lists Scheduler parameters, which are not discussed elsewher
| `Height` | `string` | A `height` style in [any supported unit]({%slug common-features/dimensions%}). |
| `Width` | `string` | A `width` style in [any supported unit]({%slug common-features/dimensions%}). |

## Scheduler Reference and Methods

To execute Scheduler methods, obtain reference to the component instance with `@ref`.

| Method | Description |
|---------|-------------|
| `Rebind` | Use to refresh the component data. |
| `Refresh` | Use to programmatically re-render the Scheduler. |

<div class="skip-repl"></div>

````CSHTML
<TelerikButton OnClick="@RefreshScheduler">Refresh Scheduler</TelerikButton>
<TelerikButton OnClick="@RefreshScheduler">Rebind Scheduler</TelerikButton>

<TelerikScheduler @ref="SchedulerRef" />

@code {
private TekerikScheduler<Appointment>? SchedulerRef { get; set; }

private void RefreshScheduler()
{
SchedulerRef?.Refresh();
}

private void RebindScheduler()
{
SchedulerRef?.Rebind();
}
}
````

## Next Steps

Expand Down
Loading