logo SERENITY
Game Systems Foundation
Search Results for

    Show / Hide Table of Contents

    Class PreviewRenderResult

    What an IViewPreviewRenderer reports back from Render(PreviewRenderContext) so the host window can overlay the selection highlight and scroll affordance, hit-test/navigate clicks, and paint the info-chip strip — without knowing which view kind produced it. Replaces the menu-only MenuPreviewResult as what the window itself consumes; a menu renderer still builds through MenuPreviewBuilder and maps its MenuPreviewResult onto this type.

    Inheritance
    object
    PreviewRenderResult
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    Namespace: Serenity.Ui.Infrastructure.Editor.Preview
    Assembly: Serenity.UnityUi.Infrastructure.Editor.dll
    Syntax
    public sealed class PreviewRenderResult

    Constructors

    PreviewRenderResult(IReadOnlyList<PreviewOptionHit>, int, bool, int, IReadOnlyList<PreviewInfoChip>)

    Declaration
    public PreviewRenderResult(IReadOnlyList<PreviewOptionHit> optionHits, int selectedIndex, bool scrollActive, int hiddenCount, IReadOnlyList<PreviewInfoChip> infoChips)
    Parameters
    Type Name Description
    IReadOnlyList<PreviewOptionHit> optionHits
    int selectedIndex
    bool scrollActive
    int hiddenCount
    IReadOnlyList<PreviewInfoChip> infoChips

    Fields

    Empty

    A result for a definition that rendered nothing (no options, no chips).

    Declaration
    public static readonly PreviewRenderResult Empty
    Field Value
    Type Description
    PreviewRenderResult

    HiddenCount

    Number of options hidden beyond the visible window (0 when not clamped).

    Declaration
    public readonly int HiddenCount
    Field Value
    Type Description
    int

    InfoChips

    The info chips the host paints for this render, in the order they should appear.

    Declaration
    public readonly IReadOnlyList<PreviewInfoChip> InfoChips
    Field Value
    Type Description
    IReadOnlyList<PreviewInfoChip>

    OptionHits

    The instantiated option rows + their TRANSITION targets, in declared order.

    Declaration
    public readonly IReadOnlyList<PreviewOptionHit> OptionHits
    Field Value
    Type Description
    IReadOnlyList<PreviewOptionHit>

    ScrollActive

    True when the view clamps to a visible window and the rest are scrolled/hidden.

    Declaration
    public readonly bool ScrollActive
    Field Value
    Type Description
    bool

    SelectedIndex

    The currently selected option index (clamped to OptionHits' range).

    Declaration
    public readonly int SelectedIndex
    Field Value
    Type Description
    int
    In this article
    © 2026 Serenity. All Rights Reserved