sgcWizard Feature Matrix
Everything sgcWizard does, grouped by task, with a link to the help topic of each feature.
Everything sgcWizard does, grouped by task, with a link to the help topic of each feature.
7 features
3 features
4 features
6 NuGet packages
Online help and PDF manuals
Registered marks the features that are in the Registered and Trial editions and not in the free Community edition. ~ marks a feature that Community has in part, with the difference below it.
Every row links to its help topic. Every feature is included in the free .NET Community edition, in Registered and in Trial.
| Feature | Details | Community | Help |
|---|---|---|---|
| Pages as steps | AddPage('Caption') adds a page and a stepper entry, with Description and StepGlyph per page. A component editor adds pages at design time. | Help | |
| Navigation | Next and Back move between the pages; Skip on a page makes them jump over it. | Help | |
| Button captions | Built-in Back, Next, Finish and Cancel buttons with your own wording: BackCaption, NextCaption, FinishCaption, CancelCaption, ShowCancel. | Help | |
| Finish and cancel | OnFinish and the cancel handling close the flow. | Help | |
| Validation | OnBeforePageChange(aFromIndex, aToIndex, var aAllow) stops the move until the page is valid. | Help | |
| Page transitions | Transition animates the change of page with wtSlide, wtFade or wtSlideFade (wtNone by default) in TransitionDuration milliseconds, 200 by default. The slide follows the direction of the move and is mirrored in right to left layouts. ReduceMotion follows the Windows animation setting by default, OnTransitionStart and OnTransitionEnd report each transition, and the new page is active and focused at once, so validation and the keyboard are not delayed. On VCL, FireMonkey, WinForms, WPF and Avalonia. | Help | |
| Summary page | With ShowSummary the wizard adds a last page that lists, for every visited page, the captions of its fields and the values the user entered, read from the labels and the controls of the page. Passwords are masked and skipped pages are left out. Each section has an Edit link that goes back to its page, and Next then returns to the summary. SummaryTitle sets the title, OnGetSummaryItems adds or changes lines and OnSummaryEdit can refuse an edit. The page follows the theme, high contrast and right to left layouts, is read by screen readers and is translated into the 12 sgcUI languages. On VCL, FireMonkey, WinForms, WPF and Avalonia. | Help |
| Feature | Details | Community | Help |
|---|---|---|---|
| Stepper layout | StepperPosition = wspTop, wspLeft or wspNone. | Help | |
| Step states | wssPending, wssActive, wssCompleted, wssError and wssSkipped, set automatically with AutoStates. | Help | |
| Standalone stepper | TsgcVCLStepper with Orientation, ActiveIndex, ShowDescriptions, Clickable and OnStepClick, no wizard needed. | Help |
| Feature | Details | Community | Help |
|---|---|---|---|
| Keyboard | Enter is Next, Escape is Cancel. | Help | |
| Themes | Light and dark themes and an accent colour: Theme, AccentColor. | Help | |
| Headless rendering | sgcWizardSaveToPNG and sgcWizardSaveToSVG on a TsgcStepperModel, also on Linux64. | Help | |
| Right to left (Arabic and Hebrew) | The stepper side, step order, connectors and the Back and Next buttons with their arrows are mirrored. Your page content follows its own direction. | Help | |
| Accessibility | The steps of the stepper with their state, the current page and the buttons of the button bar are exposed to UI Automation. Ctrl+Tab and Ctrl+Shift+Tab go to the next or previous step from anywhere inside the wizard, the stepper and the button bar are tab stops with a visible focus ring, and Windows high contrast is followed. On by default on VCL (Delphi 7 to 13), FireMonkey on Windows, WinForms, WPF and Avalonia. | Help |
The .NET wizard is a C# port with the same class names, for WinForms, WPF and Avalonia. In WPF and Avalonia a page holds one child; in WinForms a page is a container.
| Package | Edition | Contents |
|---|---|---|
esegece.sgcWizard.Community | Community (free) | Core library |
esegece.sgcWizard.WinForms.Community | Community (free) | Windows Forms controls |
esegece.sgcWizard.Wpf.Community | Community (free) | WPF controls |
esegece.sgcWizard.Avalonia.Community | Community (free) | Avalonia controls |
esegece.sgcWizard.Rendering.Community | Community (free) | Headless rendering |
esegece.sgcWizard | Registered | Core library |
esegece.sgcWizard.WinForms | Registered | Windows Forms controls |
esegece.sgcWizard.Wpf | Registered | WPF controls |
esegece.sgcWizard.Avalonia | Registered | Avalonia controls |
esegece.sgcWizard.Rendering | Registered | Headless rendering |
Every feature of sgcWizard is documented in the sgcUI help, with one build for each development environment.
Start with the sgcWizard introduction, then follow the quick start and the feature topics.
Delphi →The complete sgcUI help as a PDF file, to read offline or print.
Delphi (PDF) →